Skip to content

Commit 161210e

Browse files
committed
updated README
1 parent fd04d90 commit 161210e

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.rst

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,7 @@ This is easily achieved by downloading
2525
Usage Example
2626
=============
2727

28-
See examples/simpletest.py for a demo of the usage.
29-
30-
API Reference
31-
=============
32-
33-
.. toctree::
34-
:maxdepth: 2
35-
36-
api
28+
See examples/max9744_simpletest.py for a demo of the usage.
3729

3830
Contributing
3931
============
@@ -65,3 +57,26 @@ Then run the build:
6557
.. code-block:: shell
6658
6759
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max9744 --library_location .
60+
61+
Sphinx documentation
62+
-----------------------
63+
64+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
65+
install dependencies (feel free to reuse the virtual environment from above):
66+
67+
.. code-block:: shell
68+
69+
python3 -m venv .env
70+
source .env/bin/activate
71+
pip install Sphinx sphinx-rtd-theme
72+
73+
Now, once you have the virtual environment activated:
74+
75+
.. code-block:: shell
76+
77+
cd docs
78+
sphinx-build -E -W -b html . _build/html
79+
80+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
81+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
82+
locally verify it will pass.

0 commit comments

Comments
 (0)