Sphinx autodoc fix.

jfjlaros · Mar 4, 2021 · b7239ad · b7239ad
1 parent dcc2a25
commit b7239ad
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,6 @@
 from subprocess import call
 
+# NOTE: Add sphinx_autodoc_typehints when ReadTheDocs supports it.
 call('pip install six ..', shell=True)
 
 from simple_rpc import _get_metadata
@@ -11,5 +12,6 @@
 release = _get_metadata('Version')
 
 autoclass_content = 'both'
-extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints']
+# NOTE: Add sphinx_autodoc_typehints when ReadTheDocs supports it.
+extensions = ['sphinx.ext.autodoc']
 master_doc = 'index'
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -8,7 +8,7 @@ the ``-h`` option.
 
 ::
 
-    simple_rpc -h
+    $ simple_rpc -h
 
 .. note::
 
@@ -25,14 +25,14 @@ Connecting
 
 To detect serial devices, we recommend using the arduino-cli_ toolkit.
 
+::
+
     $ arduino-cli board list
     Port         Type              Board Name                FQBN             Core
     /dev/ttyACM0 Serial Port (USB) Arduino Mega or Mega 2560 arduino:avr:mega arduino:avr
 
-.. note::
-
-    This command will not detect any devices connected via ethernet or WiFi.
-    Use a URL_ (e.g., ``socket://192.168.1.50:10000``) instead.
+This command will not detect any devices connected via ethernet or WiFi. Use a
+URL_ (e.g., ``socket://192.168.1.50:10000``) instead.
 
 
 Method discovery
@@ -49,7 +49,7 @@ Alternatively, for ethernet and WiFi devices.
 
 ::
 
-    simple_rpc list socket://192.168.1.50:10000
+    $ simple_rpc list socket://192.168.1.50:10000
 
 If the Arduino has exposed the functions ``inc`` and ``set_led`` like in the
 example_ given in the device library documentation, the ``list`` subcommand