Skip to content

Commit 38b8823

Browse files
authored
Merge pull request #23 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 7693aa8 + e6cb611 commit 38b8823

File tree

1 file changed

+6
-47
lines changed

1 file changed

+6
-47
lines changed

README.rst

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ This is easily achieved by downloading
2929
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3030

3131
Installing from PyPI
32-
--------------------
32+
====================
33+
3334
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
3435
PyPI <https://pypi.org/project/adafruit-circuitpython-pca9685/>`_. To install for current user:
3536

@@ -51,7 +52,7 @@ To install in a virtual environment in your current project:
5152
python3 -m venv .env
5253
source .env/bin/activate
5354
pip3 install adafruit-circuitpython-pca9685
54-
55+
5556
Usage Example
5657
=============
5758

@@ -64,49 +65,7 @@ Contributions are welcome! Please read our `Code of Conduct
6465
<https://github.com/adafruit/Adafruit_CircuitPython_PCA9685/blob/master/CODE_OF_CONDUCT.md>`_
6566
before contributing to help this project stay welcoming.
6667

67-
Building locally
68-
================
69-
70-
To build this library locally you'll need to install the
71-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
72-
73-
.. code-block:: shell
74-
75-
python3 -m venv .env
76-
source .env/bin/activate
77-
pip install circuitpython-build-tools
78-
79-
Once installed, make sure you are in the virtual environment:
80-
81-
.. code-block:: shell
82-
83-
source .env/bin/activate
84-
85-
Then run the build:
86-
87-
.. code-block:: shell
88-
89-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pca9685 --library_location .
90-
91-
Sphinx documentation
92-
-----------------------
93-
94-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
95-
install dependencies (feel free to reuse the virtual environment from above):
96-
97-
.. code-block:: shell
98-
99-
python3 -m venv .env
100-
source .env/bin/activate
101-
pip install Sphinx sphinx-rtd-theme
102-
103-
Now, once you have the virtual environment activated:
104-
105-
.. code-block:: shell
106-
107-
cd docs
108-
sphinx-build -E -W -b html . _build/html
68+
Documentation
69+
=============
10970

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