Skip to content

Commit a4d0e17

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 89faee0 commit a4d0e17

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

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

162-
Building locally
163-
================
164-
165-
To build this library locally you'll need to install the
166-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
167-
168-
.. code-block:: shell
169-
170-
python3 -m venv .env
171-
source .env/bin/activate
172-
pip install circuitpython-build-tools
173-
174-
Once installed, make sure you are in the virtual environment:
175-
176-
.. code-block:: shell
177-
178-
source .env/bin/activate
179-
180-
Then run the build:
181-
182-
.. code-block:: shell
183-
184-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-hid --library_location .
185-
186-
Sphinx documentation
187-
-----------------------
188-
189-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
190-
install dependencies (feel free to reuse the virtual environment from above):
191-
192-
.. code-block:: shell
193-
194-
python3 -m venv .env
195-
source .env/bin/activate
196-
pip install Sphinx sphinx-rtd-theme
197-
198-
Now, once you have the virtual environment activated:
199-
200-
.. code-block:: shell
201-
202-
cd docs
203-
sphinx-build -E -W -b html . _build/html
162+
Documentation
163+
=============
204164

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