Skip to content

Commit d2ea105

Browse files
authored
Merge pull request #9 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 47c8b0f + debdc66 commit d2ea105

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -104,52 +104,7 @@ Contributions are welcome! Please read our `Code of Conduct
104104
<https://github.com/adafruit/Adafruit_CircuitPython_Hue/blob/master/CODE_OF_CONDUCT.md>`_
105105
before contributing to help this project stay welcoming.
106106

107-
Building locally
108-
================
109-
110-
Zip release files
111-
-----------------
112-
113-
To build this library locally you'll need to install the
114-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
115-
116-
.. code-block:: shell
117-
118-
python3 -m venv .env
119-
source .env/bin/activate
120-
pip install circuitpython-build-tools
121-
122-
Once installed, make sure you are in the virtual environment:
123-
124-
.. code-block:: shell
125-
126-
source .env/bin/activate
127-
128-
Then run the build:
129-
130-
.. code-block:: shell
131-
132-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-hue --library_location .
133-
134-
Sphinx documentation
135-
-----------------------
136-
137-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
138-
install dependencies (feel free to reuse the virtual environment from above):
139-
140-
.. code-block:: shell
141-
142-
python3 -m venv .env
143-
source .env/bin/activate
144-
pip install Sphinx sphinx-rtd-theme
145-
146-
Now, once you have the virtual environment activated:
147-
148-
.. code-block:: shell
149-
150-
cd docs
151-
sphinx-build -E -W -b html . _build/html
107+
Documentation
108+
=============
152109

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