Skip to content

Commit f4a59a1

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent a358476 commit f4a59a1

File tree

1 file changed

+3
-49
lines changed

1 file changed

+3
-49
lines changed

README.rst

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -148,53 +148,7 @@ Contributions are welcome! Please read our `Code of Conduct
148148
<https://github.com/adafruit/Adafruit_CircuitPython_PCF8523/blob/master/CODE_OF_CONDUCT.md>`_
149149
before contributing to help this project stay welcoming.
150150

151-
Building locally
152-
================
153-
154-
Zip release files
155-
-----------------
156-
157-
To build this library locally you'll need to install the
158-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
159-
160-
.. code-block:: shell
161-
162-
python3 -m venv .env
163-
source .env/bin/activate
164-
pip install circuitpython-build-tools
165-
166-
Once installed, make sure you are in the virtual environment:
167-
168-
.. code-block:: shell
169-
170-
source .env/bin/activate
171-
172-
Then run the build:
173-
174-
.. code-block:: shell
175-
176-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcf8523 --library_location .
177-
178-
Sphinx documentation
179-
-----------------------
180-
181-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
182-
install dependencies (feel free to reuse the virtual environment from above):
183-
184-
.. code-block:: shell
185-
186-
python3 -m venv .env
187-
source .env/bin/activate
188-
pip install Sphinx sphinx-rtd-theme
189-
190-
Now, once you have the virtual environment activated:
191-
192-
.. code-block:: shell
193-
194-
cd docs
195-
sphinx-build -E -W -b html . _build/html
196-
197-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
198-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
199-
locally verify it will pass.
151+
Documentation
152+
=============
200153

154+
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)