Skip to content

Commit e0b7907

Browse files
authored
Merge pull request #11 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents c737886 + df18b6b commit e0b7907

File tree

1 file changed

+4
-49
lines changed

1 file changed

+4
-49
lines changed

README.rst

+4-49
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This is easily achieved by downloading
2727
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2828

2929
Installing from PyPI
30-
--------------------
30+
====================
3131

3232
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
3333
PyPI <https://pypi.org/project/adafruit-circuitpython-bluefruitspi/>`_. To install for current user:
@@ -125,52 +125,7 @@ Contributions are welcome! Please read our `Code of Conduct
125125
<https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI/blob/master/CODE_OF_CONDUCT.md>`_
126126
before contributing to help this project stay welcoming.
127127

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

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