Skip to content

Commit 79943b0

Browse files
authored
Merge pull request #21 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents cc5598b + b3be5ac commit 79943b0

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

92-
Building locally
93-
================
94-
95-
Zip release files
96-
-----------------
97-
98-
To build this library locally you'll need to install the
99-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
100-
101-
.. code-block:: shell
102-
103-
python3 -m venv .env
104-
source .env/bin/activate
105-
pip install circuitpython-build-tools
106-
107-
Once installed, make sure you are in the virtual environment:
108-
109-
.. code-block:: shell
110-
111-
source .env/bin/activate
112-
113-
Then run the build:
114-
115-
.. code-block:: shell
116-
117-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motorkit --library_location .
118-
119-
Sphinx documentation
120-
-----------------------
121-
122-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
123-
install dependencies (feel free to reuse the virtual environment from above):
124-
125-
.. code-block:: shell
126-
127-
python3 -m venv .env
128-
source .env/bin/activate
129-
pip install Sphinx sphinx-rtd-theme
130-
131-
Now, once you have the virtual environment activated:
132-
133-
.. code-block:: shell
134-
135-
cd docs
136-
sphinx-build -E -W -b html . _build/html
92+
Documentation
93+
=============
13794

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