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