pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixing Sphinx warnings during doc generation

Browse source
This commit is contained in:
Peter Backx 2017-10-25 20:58:34 +02:00 committed by Gina Häußge
parent 772ee76e76
commit a0df4e78b5
12 changed files with 30 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/connection.rst
View file

@ -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",

1
docs/api/files.rst
View file

@ -192,6 +192,7 @@ Retrieve all files
"refs": {
"resource": "http://example.com/api/files/local/folderA/subfolder",
}
}
],
"size": 1334,
"refs": {

6
docs/api/languages.rst
View file

@ -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"
},
...
}
]
}
}

7
docs/api/settings.rst
View file

@ -62,10 +62,11 @@ Save settings
{
"api": {
"enabled": true,
// ...
"enabled": true
},
// ...
"appearance": {
"color": "black"
}
}
.. _sec-api-settings-generateapikey:

12
docs/api/slicing.rst
View file

@ -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
}
}

2
docs/api/system.rst
View file

@ -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

12
docs/bundledplugins/pluginmanager.rst
View file

@ -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",

4
docs/jsclientlib/index.rst
View file

@ -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
<!--
full client library or all individual files, depending
@ -35,7 +35,7 @@ correct URL prefix:
Regardless of which way you use to include the library, you'll also need to make sure you included JQuery and lodash,
because the library depends on those to be available (as ``$`` and ``_``). You can embed those like this:
.. code-block:: html
.. code-block:: html+jinja
<script src="{{ url_for("static", filename="js/lib/jquery/jquery.min.js") }}"></script>
<script src="{{ url_for("static", filename="js/lib/lodash.min.js") }}"></script>

6
docs/plugins/gettingstarted.rst
View file

@ -821,9 +821,9 @@ Put something like the following into ``helloworld.css``:
:linenos:
#tab_plugin_helloworld iframe {
width: 100%;
height: 600px;
border: 1px solid #808080;
width: 100%;
height: 600px;
border: 1px solid #808080;
}
Don't forget to remove the ``style`` attribute from the ``iframe`` tag in ``helloworld_tab.jinja2``:

4
src/octoprint/printer/__init__.py
View file

@ -236,7 +236,7 @@ class PrinterInterface(object):
A file that is currently being printed is not allowed to be modified. Any other file or the current file
when it is not being printed is fine though.
.. since:: 1.3.2
:since: 1.3.2
.. warning::
@ -259,7 +259,7 @@ class PrinterInterface(object):
Returns whether the provided ``path`` (on the printer's SD if ``sd`` is True) is the currently selected
file for printing.
.. since:: 1.3.2
:since: 1.3.2
.. warning::

2
src/octoprint/settings.py
View file

@ -800,7 +800,7 @@ class Settings(object):
def last_modified(self):
"""
Returns:
int: The last modification time of the configuration file.
(int) The last modification time of the configuration file.
"""
stat = os.stat(self._configfile)
return stat.st_mtime

8
src/octoprint/slicing/__init__.py
View file

@ -147,7 +147,7 @@ class SlicingManager(object):
def slicing_enabled(self):
"""
Returns:
boolean: True if there is at least one configured slicer available, False otherwise.
(boolean) True if there is at least one configured slicer available, False otherwise.
"""
return len(self.configured_slicers) > 0
@ -155,7 +155,7 @@ class SlicingManager(object):
def registered_slicers(self):
"""
Returns:
list of str: Identifiers of all available slicers.
(list of str) Identifiers of all available slicers.
"""
return self._slicers.keys()
@ -163,7 +163,7 @@ class SlicingManager(object):
def configured_slicers(self):
"""
Returns:
list of str: Identifiers of all available configured slicers.
(list of str) Identifiers of all available configured slicers.
"""
return map(lambda slicer: slicer.get_slicer_properties()["type"], filter(lambda slicer: slicer.is_slicer_configured(), self._slicers.values()))
@ -173,7 +173,7 @@ class SlicingManager(object):
Retrieves the default slicer.
Returns:
str: The identifier of the default slicer or ``None`` if the default slicer is not registered in the
(str) The identifier of the default slicer or ``None`` if the default slicer is not registered in the
system.
"""
slicer_name = settings().get(["slicing", "defaultSlicer"])