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
before contributing to help this project stay welcoming.
113
113
114
-
Sphinx documentation
115
-
-----------------------
116
-
117
-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
118
-
install dependencies (feel free to reuse the virtual environment from above):
119
-
120
-
.. code-block:: shell
121
-
122
-
python3 -m venv .env
123
-
source .env/bin/activate
124
-
pip install Sphinx sphinx-rtd-theme
125
-
126
-
Now, once you have the virtual environment activated:
127
-
128
-
.. code-block:: shell
129
-
130
-
cd docs
131
-
sphinx-build -E -W -b html . _build/html
114
+
Documentation
115
+
=============
132
116
133
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
134
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
135
-
locally verify it will pass.
117
+
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