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
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
d447308ef0
Even more documentation of the internal modules
2015-03-06 01:42:49 +01:00
Gina Häußge
cd3ead3f30
More documentation
2015-02-27 20:28:24 +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
8b4b5fb058
Documented slightly changed view model registration
...
Still backwards compatible though!
2015-02-23 14:00:14 +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
d3bd990009
The plugin system now also injects self._settings into SettingsPlugins and create the blueprint for BlueprintPlugins
...
Also adjusted a lot of documentation for that stuff and continued writing the Getting Started guide for plugin development.
2015-01-30 13:22:35 +01:00
Gina Häußge
b4068f36e1
Highlighted changed lines
2015-01-27 16:08:10 +01:00
Gina Häußge
4223d48edd
Docs: Started on a basic plugin tutorial
2015-01-27 14:21:41 +01:00
Gina Häußge
922ee39109
Plugins can now also supply information regarding the plugin author and website, metadata also tracks from where they were loaded
2015-01-26 12:51:44 +01:00
Gina Häußge
762ec228da
More work on the documentation
2015-01-16 17:11:31 +01:00
Gina Häußge
be8ffeb724
WIP: Some documentation of plugins
2015-01-13 10:31:56 +01:00
Gina Häußge
60ca95e9b2
Started documenting plugin types and their API
2014-09-30 23:20:47 +02:00
Gina Häußge
26e9a17c6b
Started working on the documentation of the plugin system
2014-09-12 14:26:29 +02:00
