Skip to content

Commit 82de84d

Browse files
author
Alec Delaney
committed
Get sphinx to build documentation
1 parent f77840d commit 82de84d

File tree

3 files changed

+5
-17
lines changed

3 files changed

+5
-17
lines changed

README.rst

+2-10
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,11 @@ This is easily achieved by downloading
3737
or individual libraries can be installed using
3838
`circup <https://github.com/adafruit/circup>`_.
3939

40-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
41-
image from the assets folder in the PCB's GitHub repo.
42-
43-
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5611 >`_
40+
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5611>`_
4441

4542

4643
Installing from PyPI
4744
=====================
48-
.. note:: This library is not available on PyPI yet. Install documentation is included
49-
as a standard element. Stay tuned for PyPI availability!
50-
51-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
5245

5346
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5447
PyPI <https://pypi.org/project/adafruit-circuitpython-pcf8575/>`_.
@@ -101,8 +94,7 @@ Or the following command to update an existing version:
10194
Usage Example
10295
=============
10396

104-
.. todo:: Add a quick, simple example. It and other examples should live in the
105-
examples folder and be included in docs/examples.rst.
97+
See the ``examples/`` folder for usage examples.
10698

10799
Documentation
108100
=============

adafruit_pcf8575.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
"""
66
`adafruit_pcf8575`
7-
================================================================================
7+
==================
88
99
CircuitPython library for Adafruit PCF8575 GPIO expander
1010
@@ -16,7 +16,7 @@
1616
1717
**Hardware:**
1818
19-
* `Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>`
19+
* `Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>`_
2020
2121
**Software and Dependencies:**
2222

docs/index.rst

+1-5
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,10 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

27-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28-
the toctree above for use later.
29-
3027
.. toctree::
3128
:caption: Related Products
3229

33-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
34-
the toctree above for use later.
30+
Adafruit PCF8575 GPIO Expander <https://www.adafruit.com/product/5611>
3531

3632
.. toctree::
3733
:caption: Other Links

0 commit comments

Comments
 (0)