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,
182
-
install dependencies (feel free to reuse the virtual environment from above):
183
-
184
-
.. code-block:: shell
185
-
186
-
python3 -m venv .env
187
-
source .env/bin/activate
188
-
pip install Sphinx sphinx-rtd-theme
189
-
190
-
Now, once you have the virtual environment activated:
191
-
192
-
.. code-block:: shell
193
-
194
-
cd docs
195
-
sphinx-build -E -W -b html . _build/html
196
-
197
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
198
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
199
-
locally verify it will pass.
151
+
Documentation
152
+
=============
200
153
154
+
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