Skip to content

Commit 778c0e0

Browse files
committed
updated README
1 parent 98e0b33 commit 778c0e0

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.rst

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,22 @@ Adafruit CircuitPython module for the LIS3DH accelerometer.
1414

1515
Note this module is made to work with CircuitPython and not MicroPython APIs.
1616

17+
Usage Example
18+
=============
19+
1720
See the guide at: https://learn.adafruit.com/circuitpython-hardware-lis3dh-accelerometer
1821

1922
Dependencies
2023
=============
2124
This driver depends on:
2225

2326
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
27+
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
2428

2529
Please ensure all dependencies are available on the CircuitPython filesystem.
2630
This is easily achieved by downloading
2731
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2832

29-
API Reference
30-
=============
31-
32-
.. toctree::
33-
:maxdepth: 2
34-
35-
api
36-
3733
Contributing
3834
============
3935

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

0 commit comments

Comments
 (0)