Skip to content

Commit e611944

Browse files
brentrubrentru
authored andcommitted
docs!
1 parent fba0837 commit e611944

File tree

4 files changed

+3
-15
lines changed

4 files changed

+3
-15
lines changed

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
55
.. use this format as the module name: "adafruit_foo.foo"
66
7-
.. automodule:: adafruit_adafruit_io
7+
.. automodule:: adafruit_adafruitio
88
:members:

docs/conf.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,6 @@
1616
'sphinx.ext.todo',
1717
]
1818

19-
# TODO: Please Read!
20-
# Uncomment the below if you use native CircuitPython modules such as
21-
# digitalio, micropython and busio. List the modules you use. Without it, the
22-
# autodoc module docs will fail to generate with a warning.
23-
# autodoc_mock_imports = ["digitalio", "busio"]
24-
25-
2619
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
2720

2821
# Add any paths that contain templates here, relative to this directory.

docs/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Simple test
33

44
Ensure your device works with this simple test.
55

6-
.. literalinclude:: ../examples/adafruit_io_simpletest.py
7-
:caption: examples/adafruit_io_simpletest.py
6+
.. literalinclude:: ../examples/adafruit_io_simpletest_data.py
7+
:caption: examples/adafruit_io_simpletest_data.py
88
:linenos:

docs/index.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,10 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

26-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
27-
the toctree above for use later.
2826

2927
.. toctree::
3028
:caption: Related Products
3129

32-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33-
the toctree above for use later.
34-
3530
.. toctree::
3631
:caption: Other Links
3732

0 commit comments

Comments
 (0)