Sphinx autodoc fix.

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

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
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
@@ -25,6 +25,8 @@ 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