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.
70
70
71
-
Sphinx documentation
72
-
-----------------------
73
-
74
-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
75
-
install dependencies (feel free to reuse the virtual environment from above):
76
-
77
-
.. code-block:: shell
78
-
79
-
python3 -m venv .env
80
-
source .env/bin/activate
81
-
pip install Sphinx sphinx-rtd-theme
82
-
83
-
Now, once you have the virtual environment activated:
84
-
85
-
.. code-block:: shell
86
-
87
-
cd docs
88
-
sphinx-build -E -W -b html . _build/html
71
+
Documentation
72
+
=============
89
73
90
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
91
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
92
-
locally verify it will pass.
74
+
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>`_.
93
75
94
76
License
95
77
========
@@ -98,4 +80,4 @@ This library was written by Arduino SA. We've converted it to work with Adafruit
98
80
changes for it to work with CircuitPython devices and single-board linux computers running CircuitPython libraries. We've
99
81
added examples to demonstrate using the nonce, random, monotonic counter and SHA256 security functions within the library.
100
82
101
-
This open source code is licensed under the LGPL License (see LICENSE for details).
83
+
This open source code is licensed under the LGPL License (see LICENSE for details).
0 commit comments