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.
71
71
72
-
Sphinx documentation
73
-
-----------------------
74
-
75
-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
76
-
install dependencies (feel free to reuse the virtual environment from above):
77
-
78
-
.. code-block:: shell
79
-
80
-
python3 -m venv .env
81
-
source .env/bin/activate
82
-
pip install Sphinx sphinx-rtd-theme
83
-
84
-
Now, once you have the virtual environment activated:
85
-
86
-
.. code-block:: shell
87
-
88
-
cd docs
89
-
sphinx-build -E -W -b html . _build/html
72
+
Documentation
73
+
=============
90
74
91
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
92
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
93
-
locally verify it will pass.
75
+
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>`_.
94
76
95
77
License
96
78
=======
@@ -102,4 +84,4 @@ CircuitPython and the CircuitPython API.
102
84
We've added examples for using this library to transmit board telemetry data along
103
85
with sensor data to Google's Cloud Platform.
104
86
105
-
This open source code is licensed under the Apache license (see LICENSE) for details.
87
+
This open source code is licensed under the Apache license (see LICENSE) for details.
0 commit comments