File tree Expand file tree Collapse file tree 1 file changed +27
-8
lines changed Expand file tree Collapse file tree 1 file changed +27
-8
lines changed Original file line number Diff line number Diff line change @@ -14,26 +14,22 @@ Adafruit CircuitPython module for the LIS3DH accelerometer.
14
14
15
15
Note this module is made to work with CircuitPython and not MicroPython APIs.
16
16
17
+ Usage Example
18
+ =============
19
+
17
20
See the guide at: https://learn.adafruit.com/circuitpython-hardware-lis3dh-accelerometer
18
21
19
22
Dependencies
20
23
=============
21
24
This driver depends on:
22
25
23
26
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
27
+ * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice >`_
24
28
25
29
Please ensure all dependencies are available on the CircuitPython filesystem.
26
30
This is easily achieved by downloading
27
31
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_.
28
32
29
- API Reference
30
- =============
31
-
32
- .. toctree ::
33
- :maxdepth: 2
34
-
35
- api
36
-
37
33
Contributing
38
34
============
39
35
@@ -64,3 +60,26 @@ Then run the build:
64
60
.. code-block::shell
65
61
66
62
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.
You can’t perform that action at this time.
0 commit comments