Skip to content

Commit

Permalink
Merge pull request #6 from adafruit/dherrada-patch-1
Browse files Browse the repository at this point in the history
Removed building locally section from README, replaced with documenta…
  • Loading branch information
kattni committed Oct 21, 2019
2 parents 7a999c4 + 3777131 commit f3bd752
Showing 1 changed file with 3 additions and 21 deletions.
24 changes: 3 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,25 +83,7 @@ Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

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
Documentation
=============

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>`_.

0 comments on commit f3bd752

Please sign in to comment.