Skip to content

Commit 80b349f

Browse files
committed
updated README
1 parent f7a6772 commit 80b349f

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.rst

+23-8
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,6 @@ Usage Example
3636
ds18.temperature
3737
3838
39-
API Reference
40-
=============
41-
42-
.. toctree::
43-
:maxdepth: 2
44-
45-
api
46-
4739
Contributing
4840
============
4941

@@ -74,3 +66,26 @@ Then run the build:
7466
.. code-block:: shell
7567
7668
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds18x20 --library_location .
69+
70+
Sphinx documentation
71+
-----------------------
72+
73+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
74+
install dependencies (feel free to reuse the virtual environment from above):
75+
76+
.. code-block:: shell
77+
78+
python3 -m venv .env
79+
source .env/bin/activate
80+
pip install Sphinx sphinx-rtd-theme
81+
82+
Now, once you have the virtual environment activated:
83+
84+
.. code-block:: shell
85+
86+
cd docs
87+
sphinx-build -E -W -b html . _build/html
88+
89+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
90+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
91+
locally verify it will pass.

0 commit comments

Comments
 (0)