Skip to content

Commit 54fc1d0

Browse files
authored
Merge pull request #5 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 1804074 + 278c659 commit 54fc1d0

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -120,52 +120,7 @@ Contributions are welcome! Please read our `Code of Conduct
120120
<https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/blob/master/CODE_OF_CONDUCT.md>`_
121121
before contributing to help this project stay welcoming.
122122

123-
Building locally
124-
================
125-
126-
Zip release files
127-
-----------------
128-
129-
To build this library locally you'll need to install the
130-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
131-
132-
.. code-block:: shell
133-
134-
python3 -m venv .env
135-
source .env/bin/activate
136-
pip install circuitpython-build-tools
137-
138-
Once installed, make sure you are in the virtual environment:
139-
140-
.. code-block:: shell
141-
142-
source .env/bin/activate
143-
144-
Then run the build:
145-
146-
.. code-block:: shell
147-
148-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgbled --library_location .
149-
150-
Sphinx documentation
151-
-----------------------
152-
153-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
154-
install dependencies (feel free to reuse the virtual environment from above):
155-
156-
.. code-block:: shell
157-
158-
python3 -m venv .env
159-
source .env/bin/activate
160-
pip install Sphinx sphinx-rtd-theme
161-
162-
Now, once you have the virtual environment activated:
163-
164-
.. code-block:: shell
165-
166-
cd docs
167-
sphinx-build -E -W -b html . _build/html
123+
Documentation
124+
=============
168125

169-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
170-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
171-
locally verify it will pass.
126+
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

Comments
 (0)