Skip to content

Commit 52aab87

Browse files
authored
Merge pull request #1 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 71f62aa + b076879 commit 52aab87

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

111-
Building locally
112-
================
113-
114-
Zip release files
115-
-----------------
116-
117-
To build this library locally you'll need to install the
118-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
119-
120-
.. code-block:: shell
121-
122-
python3 -m venv .env
123-
source .env/bin/activate
124-
pip install circuitpython-build-tools
125-
126-
Once installed, make sure you are in the virtual environment:
127-
128-
.. code-block:: shell
129-
130-
source .env/bin/activate
131-
132-
Then run the build:
133-
134-
.. code-block:: shell
135-
136-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds3502 --library_location .
137-
138-
Sphinx documentation
139-
-----------------------
140-
141-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
142-
install dependencies (feel free to reuse the virtual environment from above):
143-
144-
.. code-block:: shell
145-
146-
python3 -m venv .env
147-
source .env/bin/activate
148-
pip install Sphinx sphinx-rtd-theme
149-
150-
Now, once you have the virtual environment activated:
151-
152-
.. code-block:: shell
153-
154-
cd docs
155-
sphinx-build -E -W -b html . _build/html
111+
Documentation
112+
=============
156113

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