Gina Häußge
c6fdab554b
[doc] documented viewmodels and their callbacks and dependency injection for usage in plugins
2015-04-23 17:27:25 +02:00
Gina Häußge
c6a0ef2425
[doc] documented gcode scripts and snippets
2015-04-23 14:05:10 +02:00
Gina Häußge
a146cb193b
[docs] Updated and sorted sections in docs of control.yaml, added reference to plugin repository
2015-04-23 12:22:21 +02:00
Gina Häußge
a996f7b6fb
New hook octoprint.filemanager.preprocessor
...
Allows preprocessing files that are uploaded or otherwise added to the system (e.g. through slicing) before their contents are saved to disk
2015-04-17 14:45:58 +02:00
Gina Häußge
023b6f9d81
Small fixes prior to merge of #849
...
* Renamed userjson to userdata, removed original userdata (developers will live if they need to ensure their supplied userdata is valid JSON)
* Input validation for userdata parameter - a HTTP 400 response will be generated if userdata can't be parsed as JSON
* Adjusted documentation accordingly
2015-04-16 16:05:23 +02:00
Gina Häußge
694a8febb5
Merge branch 'jm/feature-metadata-endpoint' of https://github.com/Voxel8/OctoPrint into pr/jminardi/feature-metadata-endpoint
2015-04-16 15:39:35 +02:00
Gina Häußge
1d98135f58
New hook "octoprint.filemanager.extension_tree"
...
Allows extending the list of supported file extensions for the file manager.
See also discussion on #850
2015-04-16 13:09:05 +02:00
Gina Häußge
8ac375fc9b
Some minor changes before merging the PR
...
* moved virtual printer into plugin
* made default serial factory use supplied parameters instead of directly utilizing self._port and similar
* documented new hook
2015-04-16 11:43:30 +02:00
Gina Häußge
c5484fe139
[Docs] Forgot to check in an image
2015-04-15 18:57:30 +02:00
Gina Häußge
b61996c761
__plugin_init__ => __plugin_load__
2015-04-14 18:01:17 +02:00
Gina Häußge
2aa31024e6
Finalizing first version of plugin lifecycle management
2015-04-14 17:55:46 +02:00
Jack Minardi
fb99c56985
document new optional form parameters
2015-04-06 16:45:29 -04:00
Gina Häußge
a34cbc58dc
Merge pull request #828 from Voxel8/update-selected-event
...
update FileSelected event to be more consistent with other events
2015-04-02 22:14:12 +02:00
Jack Minardi
5eface585d
update docs to reflect new payload data
2015-04-02 14:53:00 -04:00
Gina Häußge
8a41cef00b
[Doc] Restructured the plugins section so it makes more sense
2015-03-31 20:08:32 +02:00
Gina Häußge
5c228e6071
[Doc] Big overhaul of TemplatePlugin docs & component ordering
2015-03-31 18:23:18 +02:00
Gina Häußge
8ff0096eb6
Fix & Docs: Plugins may only have one mixin implementation
...
Multiple mixins are allowed of course. Allowing multiple implementations lead to too many problems due to plugin names for referring to the APIs of SimpleApiPlugins or the assets of AssetPlugins.
Hence __plugin_implementations__ has been deprecated in favor of __plugin_implementation__. The plugin subsystem will automatically copy the first implementation from __plugin_implementations__ to __plugin_implementation__ and log a deprecation warning.
Adjusted documentation accordingly. Also added docs for helpers.
2015-03-30 16:50:06 +02:00
Gina Häußge
fb2719ce8a
[Doc] let's see if moving the figures out of the tables solves the PDF issue
2015-03-26 10:55:51 +01:00
Gina Häußge
94b207257e
[Doc] ok, that was not it, reverting and trying something else
2015-03-26 10:24:33 +01:00
Gina Häußge
1b6b0181c5
[Doc] quick test if the whitespace enabled code-block causes the PDF build errors on RTD or something else
2015-03-26 10:19:33 +01:00
Gina Häußge
45bf398494
[Docs] Added an example for octoprint.comm.protocol.action handler
...
Used same example to illustrate hook handlers within mixin implementations.
2015-03-25 19:30:49 +01:00
Gina Häußge
7bba22c5d2
[Doc] Include example for octoprint.comm.protocol.scripts hook
2015-03-25 18:45:32 +01:00
Gina Häußge
c6e4057add
[Docs] Documented octoprint.comm.protocol.gcode hook
...
Experimenting with including examples stored on github, let's see if RTD likes that.
2015-03-25 18:24:51 +01:00
Gina Häußge
b3739c10cc
[Docs] Started documenting plugin hooks and core concepts.
2015-03-25 09:39:25 +01:00
Gina Häußge
3ebd54d888
[Docs] sphinxcontrib.napoleon => sphinx.ext.napoleon
2015-03-20 11:39:09 +01:00
Gina Häußge
d198cccf75
[Docs] RTD needs a little extra help to get the code tag colors fixed...
2015-03-19 21:05:27 +01:00
Gina Häußge
05f6425a53
Fixed some documentation and implementation details on the slicing API
2015-03-19 21:03:28 +01:00
Gina Häußge
f2eeb50381
Lots of documentation for slicing related things and some refactorings
2015-03-19 20:58:24 +01:00
Gina Häußge
b17730137a
[Doc] Fixed colors for code elements, no more red, also different color for links
2015-03-19 20:56:46 +01:00
Gina Häußge
6797432f9b
[doc] Move whitespace visualization up a bit
...
As suggested by @Mikk36
2015-03-12 18:09:24 +01:00
Gina Häußge
6c09210380
[doc] Forgot a file
2015-03-12 17:32:00 +01:00
Gina Häußge
699f7b5278
More work on custom controls
...
Added a lot of documentation, more stream lining, should now work completely without having to define types but offer the same/more functionality than before. Backwards compatible too.
2015-03-12 17:23:55 +01:00
Gina Häußge
8cba11930f
WIP: Streamlining controls to not overly depend on types anymore
2015-03-09 11:40:47 +01:00
Gina Häußge
8f6784d5d2
WIP: streamlining and documenting custom controls
2015-03-09 08:51:49 +01:00
Gina Häußge
aecc7a4734
Added triggering GCODE scripts to the REST API and custom controls
2015-03-06 16:04:43 +01:00
Gina Häußge
d447308ef0
Even more documentation of the internal modules
2015-03-06 01:42:49 +01:00
Gina Häußge
18b2b7dfe8
Fixed warnings in documentation build
2015-03-02 16:03:37 +01:00
Gina Häußge
db382e39a7
setup.py: Always include develop dependencies on RTD
2015-03-02 15:17:53 +01:00
Gina Häußge
cd3ead3f30
More documentation
2015-02-27 20:28:24 +01:00
Gina Häußge
619548d8e3
Trying to fix the stylesheet on RTD again
2015-02-26 18:33:03 +01:00
Gina Häußge
543b8df48b
Extended documentation to include replace feature for plugin template components
2015-02-24 09:29:02 +01:00
Gina Häußge
2fac5c76d9
Fixed styling of tables in docs
2015-02-23 22:15:04 +01:00
Gina Häußge
8b4b5fb058
Documented slightly changed view model registration
...
Still backwards compatible though!
2015-02-23 14:00:14 +01:00
Gina Häußge
4abcf1054b
Added controls for changing feed and flow rate factors to Controls tab
...
Closes #362
2015-02-22 21:20:56 +01:00
Gina Häußge
28738a5179
More documentation and unit tests
2015-02-18 17:16:37 +01:00
Gina Häußge
197ed7b912
More documentation
2015-02-13 12:50:02 +01:00
Gina Häußge
7de90e16f6
And of course I forgot a file again and overlooked a typo...
2015-02-12 13:34:57 +01:00
Gina Häußge
cad4e2f6dc
Update some line numbers
2015-02-12 13:31:12 +01:00
Gina Häußge
4d5443ed6b
Finalized plugin tutorial (for now)
2015-02-12 13:29:00 +01:00
Gina Häußge
e6a0019cc7
Forgot to commit an image for the documentation
2015-01-30 13:56:41 +01:00