Skip to content

Commit 99efe3a

Browse files
authored
Merge pull request #19 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents e0996c4 + ee1309d commit 99efe3a

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -79,52 +79,7 @@ Contributions are welcome! Please read our `Code of Conduct
7979
<https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4/blob/master/CODE_OF_CONDUCT.md>`_
8080
before contributing to help this project stay welcoming.
8181

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

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