From a0df4e78b57d61df9748e4580f6222509dced476 Mon Sep 17 00:00:00 2001 From: Peter Backx Date: Wed, 25 Oct 2017 20:58:34 +0200 Subject: [PATCH] Fixing Sphinx warnings during doc generation --- docs/api/connection.rst | 2 +- docs/api/files.rst | 1 + docs/api/languages.rst | 6 +----- docs/api/settings.rst | 7 ++++--- docs/api/slicing.rst | 12 ++++-------- docs/api/system.rst | 2 +- docs/bundledplugins/pluginmanager.rst | 12 ++++++------ docs/jsclientlib/index.rst | 4 ++-- docs/plugins/gettingstarted.rst | 6 +++--- src/octoprint/printer/__init__.py | 4 ++-- src/octoprint/settings.py | 2 +- src/octoprint/slicing/__init__.py | 8 ++++---- 12 files changed, 30 insertions(+), 36 deletions(-) diff --git a/docs/api/connection.rst b/docs/api/connection.rst index c0bc7537..721e92ca 100644 --- a/docs/api/connection.rst +++ b/docs/api/connection.rst @@ -39,7 +39,7 @@ Get connection settings "options": { "ports": ["/dev/ttyACM0", "VIRTUAL"], "baudrates": [250000, 230400, 115200, 57600, 38400, 19200, 9600], - "printerProfiles": [{"name": "Default", id: "_default"}], + "printerProfiles": [{"name": "Default", "id": "_default"}], "portPreference": "/dev/ttyACM0", "baudratePreference": 250000, "printerProfilePreference": "_default", diff --git a/docs/api/files.rst b/docs/api/files.rst index 76b80132..188731a4 100644 --- a/docs/api/files.rst +++ b/docs/api/files.rst @@ -192,6 +192,7 @@ Retrieve all files "refs": { "resource": "http://example.com/api/files/local/folderA/subfolder", } + } ], "size": 1334, "refs": { diff --git a/docs/api/languages.rst b/docs/api/languages.rst index ac7b988f..5fe8ad57 100644 --- a/docs/api/languages.rst +++ b/docs/api/languages.rst @@ -40,7 +40,6 @@ Retrieve installed language packs "identifier": "_core", "name": "Core", "languages": [ - ... ] }, "some_plugin": { @@ -61,7 +60,6 @@ Retrieve installed language packs "last_update": 1470859680, "author": "The italian Transifex Team" } - ... ] } } @@ -125,7 +123,6 @@ Delete a language pack "identifier": "_core", "name": "Core", "languages": [ - ... ] }, "some_plugin": { @@ -138,8 +135,7 @@ Delete a language pack "locale_english": "German", "last_update": 1474574597, "author": "Gina Häußge" - }, - ... + } ] } } diff --git a/docs/api/settings.rst b/docs/api/settings.rst index acc79722..b26b2d25 100644 --- a/docs/api/settings.rst +++ b/docs/api/settings.rst @@ -62,10 +62,11 @@ Save settings { "api": { - "enabled": true, - // ... + "enabled": true }, - // ... + "appearance": { + "color": "black" + } } .. _sec-api-settings-generateapikey: diff --git a/docs/api/slicing.rst b/docs/api/slicing.rst index 010f1af7..12965317 100644 --- a/docs/api/slicing.rst +++ b/docs/api/slicing.rst @@ -58,11 +58,9 @@ List All Slicers and Slicing Profiles "displayName": "Medium Quality", "default": true, "resource": "http://example.com/api/slicing/cura/profiles/medium_quality" - }, - ... + } } - }, - ... + } } :statuscode 200: No error @@ -104,8 +102,7 @@ List Slicing Profiles of a Specific Slicer "displayName": "Medium Quality", "default": true, "resource": "http://example.com/api/slicing/cura/profiles/medium_quality" - }, - ... + } } :param slicer: The identifying key of the slicer for which to list the available profiles. @@ -147,8 +144,7 @@ Retrieve Specific Profile "brim_line_count": 20, "cool_head_lift": false, "cool_min_feedrate": 10.0, - "cool_min_layer_time": 5.0, - ... + "cool_min_layer_time": 5.0 } } diff --git a/docs/api/system.rst b/docs/api/system.rst index 08968cec..9bf0907f 100644 --- a/docs/api/system.rst +++ b/docs/api/system.rst @@ -154,7 +154,7 @@ Execute a registered system command .. sourcecode:: http - 204 No Content + HTTP/1.1 204 No Content :param source: The source for which to list commands, currently either ``core`` or ``custom`` :param action: The identifier of the command, ``action`` from its definition diff --git a/docs/bundledplugins/pluginmanager.rst b/docs/bundledplugins/pluginmanager.rst index d2a923e8..56c5586c 100644 --- a/docs/bundledplugins/pluginmanager.rst +++ b/docs/bundledplugins/pluginmanager.rst @@ -94,15 +94,15 @@ octoprint.plugin.pluginmanager.reconnect_hooks .. py:function:: reconnect_hooks_hook(*args, **kwargs) - Returns additional hooks defined by the plugin for which the plugin manager - should display the "You should reconnect to your printer" message on plugin - install/uninstall/enabling/disabling. +Returns additional hooks defined by the plugin for which the plugin manager +should display the "You should reconnect to your printer" message on plugin +install/uninstall/enabling/disabling. - Handlers should return a Python list containing the affected hook names. +Handlers should return a Python list containing the affected hook names. - **Example** +**Example** - .. code-block:: python +.. code-block:: python def reconnect_hooks_hook(*args, **kwargs): return ["octoprint.plugin.exampleplugin.some_custom_hook", diff --git a/docs/jsclientlib/index.rst b/docs/jsclientlib/index.rst index d97da3bf..8fcc6ee1 100644 --- a/docs/jsclientlib/index.rst +++ b/docs/jsclientlib/index.rst @@ -14,7 +14,7 @@ If you are using it from a web page hosted on OctoPrint as a Jinja2 template, yo methods to embed it instead of manually entering the URL, in order to have OctoPrint take care of setting the correct URL prefix: -.. code-block:: html +.. code-block:: html+jinja