Skip to content

Commit 08fe915

Browse files
author
Kevin J Walters
committed
2 parents 0731bed + b95ab8a commit 08fe915

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

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

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