Skip to content

Commit 0eaec1e

Browse files
authored
Merge pull request #5 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents de95ad3 + b787f62 commit 0eaec1e

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
@@ -102,52 +102,7 @@ Contributions are welcome! Please read our `Code of Conduct
102102
<https://github.com/adafruit/Adafruit_CircuitPython_lifx/blob/master/CODE_OF_CONDUCT.md>`_
103103
before contributing to help this project stay welcoming.
104104

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

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