updated README

This commit is contained in:
sommersoft 2018-02-25 09:25:42 -06:00
parent 42fbf8b1f5
commit 04d364bc52

View file

@ -47,14 +47,6 @@ Usage Example
time.sleep(0.5)
API Reference
=============
.. toctree::
:maxdepth: 2
api
Contributing
============
@ -85,3 +77,26 @@ Then run the build:
.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds2413 --library_location .
Sphinx documentation
-----------------------
Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.