Commit graph

91 commits

Author SHA1 Message Date
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
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
23387d6e48 More work on the template refactoring and new template plugin types 2015-01-15 11:06:59 +01:00
Gina Häußge
466866c323 Merge remote-tracking branch 'origin/devel' into devel 2015-01-13 10:32:59 +01:00
Gina Häußge
be8ffeb724 WIP: Some documentation of plugins 2015-01-13 10:31:56 +01:00
Gina Häußge
c9c4066331 Fixed a bunch of doc issues, updated /api/printer/command to have more meaningful error messages 2014-12-31 15:47:12 +01:00
Gina Häußge
835b973bdc Merge branch 'patch-1' of https://github.com/bortek/OctoPrint into devel
Conflicts:
	docs/api/printer.rst
2014-12-31 15:19:18 +01:00
bortek
2b7885c3f8 Update printer.rst 2014-12-30 12:18:39 +01:00
Gina Häußge
363b23d6e3 Better handling of errors while sending to (disconnected) clients on the websocket 2014-12-21 15:47:24 +01:00
Gina Häußge
5784ab82ef WIP: Adding option to start printing directly after slicing 2014-12-04 15:31:00 +01:00
Gina Häußge
636e79672a The API now allows to specify where on the print bed to put the sliced model's center 2014-12-04 12:52:33 +01:00
Gina Häußge
a149cdc4f5 Added the nozzle diameter to the printer profile (needed for slicing, cura plugin uses it too) 2014-12-02 12:41:25 +01:00
Gina Häußge
fc777e69e2 API Documentation updated for printer profiles (still a WIP though) 2014-12-02 11:57:03 +01:00