File tree 1 file changed +23
-8
lines changed
1 file changed +23
-8
lines changed Original file line number Diff line number Diff line change @@ -60,14 +60,6 @@ To read from the sensor:
60
60
print (" CO2eq = %d ppm \t TVOC = %d ppb" % (co2eq, tvoc))
61
61
62
62
63
- API Reference
64
- =============
65
-
66
- .. toctree ::
67
- :maxdepth: 2
68
-
69
- api
70
-
71
63
Contributing
72
64
============
73
65
@@ -98,3 +90,26 @@ Then run the build:
98
90
.. code-block :: shell
99
91
100
92
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sgp30 --library_location .
93
+
94
+ Sphinx documentation
95
+ -----------------------
96
+
97
+ Sphinx is used to build the documentation based on rST files and comments in the code. First,
98
+ install dependencies (feel free to reuse the virtual environment from above):
99
+
100
+ .. code-block :: shell
101
+
102
+ python3 -m venv .env
103
+ source .env/bin/activate
104
+ pip install Sphinx sphinx-rtd-theme
105
+
106
+ Now, once you have the virtual environment activated:
107
+
108
+ .. code-block :: shell
109
+
110
+ cd docs
111
+ sphinx-build -E -W -b html . _build/html
112
+
113
+ This will output the documentation to ``docs/_build/html ``. Open the index.html in your browser to
114
+ view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
115
+ locally verify it will pass.
You can’t perform that action at this time.
0 commit comments