Skip to content

Commit dde7a32

Browse files
authored
Merge pull request #4 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 84dfb56 + 3c9f84d commit dde7a32

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

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

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