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,
120
-
install dependencies (feel free to reuse the virtual environment from above):
121
-
122
-
.. code-block:: shell
123
-
124
-
python3 -m venv .env
125
-
source .env/bin/activate
126
-
pip install Sphinx sphinx-rtd-theme
127
-
128
-
Now, once you have the virtual environment activated:
129
-
130
-
.. code-block:: shell
131
-
132
-
cd docs
133
-
sphinx-build -E -W -b html . _build/html
92
+
Documentation
93
+
=============
134
94
135
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
136
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
95
+
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>`_.Travis will. This is a good way to
0 commit comments