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,
94
-
install dependencies (feel free to reuse the virtual environment from above):
95
-
96
-
.. code-block:: shell
97
-
98
-
python3 -m venv .env
99
-
source .env/bin/activate
100
-
pip install Sphinx sphinx-rtd-theme
101
-
102
-
Now, once you have the virtual environment activated:
103
-
104
-
.. code-block:: shell
105
-
106
-
cd docs
107
-
sphinx-build -E -W -b html . _build/html
108
-
109
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
110
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
111
-
locally verify it will pass.
66
+
Documentation
67
+
=============
112
68
69
+
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