adafruit-mirror/Adafruit_CircuitPython_IL91874
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Removed building locally section from README, replaced with documentation section

Browse source
This commit is contained in:
dherrada 2019-10-17 18:43:59 -04:00 committed by GitHub
parent 45f6498fb1
commit def5b423e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.rst
View file

@ -105,25 +105,7 @@ Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_IL91874/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Sphinx documentation
-----------------------
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.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.