Skip to content

Commit 50d856e

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent abf6e7b commit 50d856e

File tree

1 file changed

+3
-46
lines changed

1 file changed

+3
-46
lines changed

README.rst

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -63,50 +63,7 @@ Contributions are welcome! Please read our `Code of Conduct
6363
<https://github.com/adafruit/Adafruit_CircuitPython_motor/blob/master/CODE_OF_CONDUCT.md>`_
6464
before contributing to help this project stay welcoming.
6565

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

69+
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)