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
Copy file name to clipboardExpand all lines: README.rst
+3-45
Original file line number
Diff line number
Diff line change
@@ -117,49 +117,7 @@ Contributions are welcome! Please read our `Code of Conduct
117
117
<https://github.com/adafruit/Adafruit_CircuitPython_CharLCD/blob/master/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.
118
118
119
119
120
-
Building locally
121
-
================
122
-
123
-
To build this library locally you'll need to install the
Sphinx is used to build the documentation based on rST files and comments in the code. First,
148
-
install dependencies (feel free to reuse the virtual environment from above):
149
-
150
-
.. code-block:: shell
151
-
152
-
python3 -m venv .env
153
-
source .env/bin/activate
154
-
pip install Sphinx sphinx-rtd-theme
155
-
156
-
Now, once you have the virtual environment activated:
157
-
158
-
.. code-block:: shell
159
-
160
-
cd docs
161
-
sphinx-build -E -W -b html . _build/html
120
+
Documentation
121
+
=============
162
122
163
-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
164
-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
165
-
locally verify it will pass.
123
+
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