You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sphinx is used to build the documentation based on rST files and comments in the code. First,
110
-
install dependencies (feel free to reuse the virtual environment from above):
111
-
112
-
.. code-block:: shell
113
-
114
-
python3 -m venv .env
115
-
source .env/bin/activate
116
-
pip install Sphinx sphinx-rtd-theme
117
-
118
-
Now, once you have the virtual environment activated:
119
-
120
-
.. code-block:: shell
121
-
122
-
cd docs
123
-
sphinx-build -E -W -b html . _build/html
79
+
Documentation
80
+
=============
124
81
125
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
126
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
127
-
locally verify it will pass.
82
+
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 commit comments