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,
98
-
install dependencies (feel free to reuse the virtual environment from above):
99
-
100
-
.. code-block:: shell
101
-
102
-
python3 -m venv .env
103
-
source .env/bin/activate
104
-
pip install Sphinx sphinx-rtd-theme
105
-
106
-
Now, once you have the virtual environment activated:
107
-
108
-
.. code-block:: shell
109
-
110
-
cd docs
111
-
sphinx-build -E -W -b html . _build/html
67
+
Documentation
68
+
=============
112
69
113
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
114
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
115
-
locally verify it will pass.
70
+
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>`_.
116
71
117
72
License
118
73
=======
119
74
This library was written by ClemensRiederer. We've converted it to work with Adafruit CircuitPython and made
120
75
changes so it works with the Raspberry Pi and Adafruit Feather M0/M4. We've added examples for using this library
121
76
to transmit data and sensor data to The Things Network.
122
77
123
-
This open source code is licensed under the LGPL license (see LICENSE for details).
78
+
This open source code is licensed under the LGPL license (see LICENSE for details).
0 commit comments