Skip to content

Commit 5042e20

Browse files
authored
Merge pull request #3 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 9871ba6 + 91feebf commit 5042e20

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

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

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