Daniele Forsi
edb4d0fe04
Fix warnings about duplicated names in rst files
...
Replacing a single underscore (which creates a named target) with a double
underscore creates an anonymous target.
Fixes:
/home/daniele/OctoPrint/docs/bundledplugins/cura.rst:4: WARNING: Duplicate explicit target name: "here".
/home/daniele/OctoPrint/docs/plugins/hooks.rst:370: WARNING: Invalid caption: /home/daniele/OctoPrint/docs/plugins/hooks.rst:4: (INFO/1) Duplicate explicit target name: "custom_action_command.py".
2017-07-30 23:18:08 +02:00
Gina Häußge
a6d3299b91
Add user manager factory hook
2017-07-20 20:03:05 +02:00
Gina Häußge
ee2d644239
Remove support for multi command expansion in sending phase
...
We won't support this after all, it's too much of a headache with
regards to the sending queue. Pausing takes longer, cancelling takes
longer, resends get more complicated and so on.
Command expansion in the queuing phase needs to suffice.
2017-07-17 16:26:32 +02:00
Gina Häußge
f8d225a768
Support for parsing GCODE subcodes
...
Hook handlers will get any parsed subcode as optional keyword argument
"subcode".
2017-07-05 17:56:46 +02:00
Gina Häußge
35c45df86c
Allow multi line commands in sending phase
...
(cherry picked from commit 1018946)
2017-06-23 14:55:34 +02:00
Gina Häußge
39c87d19b7
Fixed a left-over typo.
2017-05-17 17:47:58 +02:00
Gina Häußge
d029abc8f3
Updated docs with an example of multi command expansion
2017-05-17 17:47:58 +02:00
Goswin von Brederlow
917c9e54ba
Allow octoprint.comm.protocol.gcode.queuing hook to return a list of commands
2017-05-17 17:46:58 +02:00
Gina Häußge
f7eb12a3ee
Docs for {Reload|Restart}NeedingPlugin
2016-10-14 14:15:33 +02:00
Gina Häußge
0ac3881897
Use better name than "hook" for various plugin hook documentation
2016-09-20 10:29:53 +02:00
Gina Häußge
7b4b638a2b
Merge branch 'fix/pluginDocs' into dev/bundledPluginsDocs
2016-09-19 17:15:20 +02:00
Gina Häußge
4ff869c2fa
Docs for settings overlay & improved hook docs
2016-08-19 15:40:43 +02:00
Gina Häußge
b41c1d89f4
Docs for octoprint.printer.factory hook
2016-06-28 12:58:08 +02:00
Gina Häußge
ee185230a4
Refactored plugin docs + improved docs on sortables
2016-03-24 16:42:41 +01:00
Gina Häußge
1d3dfffc67
Some documentation fixes
2016-03-23 10:40:36 +01:00
Gina Häußge
780794c466
Merge branch 'development' of https://github.com/bwgan/OctoPrint into pr/bwgan/development
...
Conflicts:
src/octoprint/daemon.py
2016-01-29 09:04:58 +01:00
bwgan
f8c0df4e78
Typo and spelling fixes
...
Fixes various spelling issues and typos.
2016-01-28 18:59:38 +00:00
Gina Häußge
c6f1088ccf
<plugin identifier>:<command> => plugin:<plugin identifier> command
2015-10-30 10:14:21 +01:00
Gina Häußge
3c2d2b579d
Documention for CLI and its development
2015-10-29 17:37:05 +01:00
Gina Häußge
aeb4c21657
Started documenting octoprint.cli.commands hook
2015-10-27 12:18:01 +01:00
Nicanor Romero Venier
74b0056095
Added info to the hook's docs
2015-09-07 10:52:03 +02:00
Nicanor Romero Venier
fa95507177
Included an early return if ret is None
...
Also corrected typos, received instead of recieved.
2015-09-07 10:04:06 +02:00
Nicanor Romero Venier
ced18c86e0
Added docs for the gcode.recieved hook
2015-09-03 18:43:07 +02:00
Gina Häußge
3995a65f6c
WIP: Moving bundled plugin docs to official docs
...
The wiki is not a prominent enough location for these kind of
things apparently.
2015-07-14 21:26:07 +02:00
Gina Häußge
592cad5b99
Deprecated AppPlugin mixin and introduced octoprint.accesscontrol.appkey hook instead
...
Plugins implementing the mixin will automatically be migrated to providing the single mixin method as hook handler.
2015-06-09 18:50:55 +02:00
Gina Häußge
fde543f19e
[doc] octoprint.ui.web.templatetypes hook is now documented
2015-06-08 12:05:29 +02:00
Gina Häußge
61af59cca1
New hooks for command processing in comm layer
...
Added phase specific hooks for queuing, queued, sending and sent phases of a command ("octoprint.comm.protocol.gcode.<phase>"). Removed old queuing phase hook and declared as obsolete hook in plugin manager to prevent plugins that depend on it from being enabled.
Adding those new hooks also necessitated refactoring the whole command processing, made it more modular and added phase specific handler functions that allow handling all blocking commands centrally for example.
2015-05-28 17:06:24 +02:00
Gina Häußge
ceb0e29da3
Changed existing octoprint.server.http.* hooks to prefix routes with /plugin/<identifier>/
...
This will hopefully prevent conflicting routes between multiple plugins from being registered and also ensures a more consistent behaviour compared to BlueprintPlugin mixins.
Thanks to @Salandora for bringing this up.
2015-05-27 14:30:41 +02:00
Gina Häußge
5a89cc6a2a
[doc] Added example for the octoprint.server.http.routes hook
2015-05-26 14:29:22 +02:00
Gina Häußge
2317d0cf27
Documentation for new hook "octoprint.server.http.routes"
2015-05-26 13:16:57 +02:00
Gina Häußge
4c7520efb9
New hook "octoprint.server.http.bodysize" and lifecycle support for restart needing hooks
...
The new hook allows extending the list of rules for maximum body sizes differing from the default of 100KB and can be used by plugins to allow uploads to them that exceed that file size.
Also extended the plugin manager to detect plugins that implement restart needing hooks (such as the above one) and handling those plugins the same as plugins containing implementations that inherit from octoprint.plugin.core.RestartNeedingPlugin
2015-05-11 15:47:40 +02:00
Gina Häußge
34f1aa421f
[doc] Added *args, **kwargs to all hooks and documented adjusted gcode hook signature
...
(cherry picked from commit 30d79f4 )
2015-04-29 17:32:38 +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
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
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
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
4223d48edd
Docs: Started on a basic plugin tutorial
2015-01-27 14:21:41 +01:00