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