Skip to content

Commit 41b423f

Browse files
committed
updated README
1 parent c096261 commit 41b423f

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
@@ -112,14 +112,6 @@ To check for a object in proximity, see if a gesture is available first, then ge
112112
apds.clear_interrupt()
113113
114114
115-
API Reference
116-
=============
117-
118-
.. toctree::
119-
:maxdepth: 2
120-
121-
api
122-
123115
Contributing
124116
============
125117

@@ -150,3 +142,26 @@ Then run the build:
150142
.. code-block::shell
151143
152144
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-apds --library_location .
145+
146+
Sphinx documentation
147+
-----------------------
148+
149+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
150+
install dependencies (feel free to reuse the virtual environment from above):
151+
152+
.. code-block:: shell
153+
154+
python3 -m venv .env
155+
source .env/bin/activate
156+
pip install Sphinx sphinx-rtd-theme
157+
158+
Now, once you have the virtual environment activated:
159+
160+
.. code-block:: shell
161+
162+
cd docs
163+
sphinx-build -E -W -b html . _build/html
164+
165+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
166+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
167+
locally verify it will pass.

0 commit comments

Comments
 (0)