Skip to content

Commit 085ef4d

Browse files
committed
updated README
1 parent c2c049c commit 085ef4d

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.rst

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,6 @@ To read from the sensor:
6060
print("CO2eq = %d ppm \t TVOC = %d ppb" % (co2eq, tvoc))
6161
6262
63-
API Reference
64-
=============
65-
66-
.. toctree::
67-
:maxdepth: 2
68-
69-
api
70-
7163
Contributing
7264
============
7365

@@ -98,3 +90,26 @@ Then run the build:
9890
.. code-block:: shell
9991
10092
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.

0 commit comments

Comments
 (0)