This repository was archived by the owner on Oct 29, 2019. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +28
-8
lines changed Expand file tree Collapse file tree 1 file changed +28
-8
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,10 @@ Introduction
10
10
:target: https://discord.gg/nBQh6qu
11
11
:alt: Discord
12
12
13
+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_LSM303.svg?branch=master
14
+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_LSM303
15
+ :alt: Build Status
16
+
13
17
Adafruit CircuitPython module for the LSM303 6-DoF with 3-axis accelerometer and magnetometer
14
18
15
19
Dependencies
@@ -49,14 +53,6 @@ Usage Example
49
53
time.sleep(1.0 )
50
54
51
55
52
- API Reference
53
- =============
54
-
55
- .. toctree ::
56
- :maxdepth: 2
57
-
58
- api
59
-
60
56
Contributing
61
57
============
62
58
@@ -87,3 +83,27 @@ Then run the build:
87
83
.. code-block :: shell
88
84
89
85
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm303 --library_location .
86
+
87
+
88
+ Sphinx documentation
89
+ -----------------------
90
+
91
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
92
+ install dependencies (feel free to reuse the virtual environment from above):
93
+
94
+ .. code-block :: shell
95
+
96
+ python3 -m venv .env
97
+ source .env/bin/activate
98
+ pip install Sphinx sphinx-rtd-theme
99
+
100
+ Now, once you have the virtual environment activated:
101
+
102
+ .. code-block :: shell
103
+
104
+ cd docs
105
+ sphinx-build -E -W -b html . _build/html
106
+
107
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
108
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
109
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments