📝 Fix some intersphinx issues

foosel · foosel · commit 0aed3c05cb02 · 2020-06-16T18:09:42.000+02:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,7 +38,8 @@
               'sphinx.ext.napoleon', 'sphinxcontrib.mermaid', 'sphinx.ext.intersphinx']
 todo_include_todos = True
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
-                       'python2': ('https://docs.python.org/2', None)}
+                       'python2': ('https://docs.python.org/2', None),
+                       'pyserial': ('https://pythonhosted.org/pyserial', None)}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
diff --git a/docs/configuration/logging_yaml.rst b/docs/configuration/logging_yaml.rst
@@ -81,8 +81,8 @@ used for the ``serial.log`` and the ``console`` handler used for the output to s
        maxBytes: 2097152 # 2 * 1024 * 1024 = 2 MB in bytes
        filename: /path/to/octoprints/logs/serial.log
 
-You can find more information on the used logging handlers in the
-`Python documentation on logging handlers <https://docs.python.org/2/library/logging.handlers.html>`_.
+You can find more information on the used logging handlers in the Python documentation on
+:py:mod:`logging.handlers`.
 
 Changing logging formatters
 ---------------------------
@@ -97,4 +97,4 @@ expressed in YAML as follows:
        format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
 
 The possible keys for the logging format can be found in the
-`Python documentation on LogRecord attributes <https://docs.python.org/2/library/logging.html#logrecord-attributes>`_.
+:ref:`Python documentation on LogRecord attributes <logrecord-attributes>`.
diff --git a/docs/features/custom_controls.rst b/docs/features/custom_controls.rst
@@ -210,12 +210,12 @@ Controls
    * - ``input.slider.step``
      - (Optional) Step size per slider "tick", defaults to 1.
    * - ``regex``
-     - (Optional) A `regular expression <https://docs.python.org/2/library/re.html#regular-expression-syntax>`_ to
+     - (Optional) A :ref:`regular expression <re-syntax>` to
        match against lines received from the printer to retrieve information from it (e.g. specific output). Together
        with ``template`` this allows rendition of received data from the printer within the UI.
    * - ``template``
      - (Optional) A template to use for rendering the match of ``regex``. May contain placeholders in
-       `Python Format String Syntax <https://docs.python.org/2/library/string.html#format-string-syntax>`_ for either named
+       :ref:`Python Format String Syntax <formatstrings>` for either named
        groups within the regex (e.g. ``Temperature: {temperature}`` for a regex ``T:\s*(?P<temperature>\d+(\.\d*)``)
        or positional groups within the regex (e.g. ``Position: X={0}, Y={1}, Z={2}, E={3}`` for a regex
        ``X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)``).
diff --git a/docs/plugins/hooks.rst b/docs/plugins/hooks.rst
@@ -926,21 +926,21 @@ octoprint.comm.transport.serial.factory
    closely if directly utilizing :class:`~octoprint.util.comm.MachineCom` functionality.
 
    A valid serial instance is expected to provide the following methods, analogue to PySerial's
-   `serial.Serial <https://pythonhosted.org//pyserial/pyserial_api.html#serial.Serial>`_:
+   :py:class:`serial.Serial`:
 
    readline(size=None, eol='\n')
-       Reads a line from the serial connection, compare `serial.Filelike.readline <https://pythonhosted.org//pyserial/pyserial_api.html#serial.FileLike.readline>`_.
+       Reads a line from the serial connection, compare :py:meth:`serial.Serial.readline`.
    write(data)
-       Writes data to the serial connection, compare `serial.Filelike.write <https://pythonhosted.org//pyserial/pyserial_api.html#serial.FileLike.write>`_.
+       Writes data to the serial connection, compare :py:meth:`serial.Serial.write`.
    close()
-       Closes the serial connection, compare `serial.Serial.close <https://pythonhosted.org//pyserial/pyserial_api.html#serial.Serial.close>`_.
+       Closes the serial connection, compare :py:meth:`serial.Serial.close`.
 
    Additionally setting the following attributes need to be supported if baudrate detection is supposed to work:
 
    baudrate
-       An integer describing the baudrate to use for the serial connection, compare `serial.Serial.baudrate <https://pythonhosted.org//pyserial/pyserial_api.html#serial.Serial.baudrate>`_.
+       An integer describing the baudrate to use for the serial connection, compare :py:attr:`serial.Serial.baudrate`.
    timeout
-       An integer describing the read timeout on the serial connection, compare `serial.Serial.timeout <https://pythonhosted.org//pyserial/pyserial_api.html#serial.Serial.timeout>`_.
+       An integer describing the read timeout on the serial connection, compare :py:attr:`serial.Serial.timeout`.
 
    **Example:**
 
diff --git a/docs/plugins/injectedproperties.rst b/docs/plugins/injectedproperties.rst
@@ -22,7 +22,7 @@ An overview of these properties follows.
   data files etc). Plugins should not access this property directly but instead utilize :func:`~octoprint.plugin.types.OctoPrintPlugin.get_plugin_data_folder`
   which will make sure the path actually does exist and if not create it before returning it.
 ``self._logger``
-  A `python logger instance <https://docs.python.org/2/library/logging.html>`_ logging to the log target
+  A :py:class:`logging.Logger` instance logging to the log target
   ``octoprint.plugin.<plugin identifier>``.
 ``self._settings``
   The plugin's personalized settings manager, injected only into plugins that include the :class:`~octoprint.plugin.SettingsPlugin` mixin.
