Skip to content

Commit 2190737

Browse files
authored
Merge pull request #42 from adafruit/dherrada-patch-1
Removed building locally section, replaced with documentation section
2 parents 33bb64c + 6fee72b commit 2190737

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

+3-45
Original file line numberDiff line numberDiff line change
@@ -93,49 +93,7 @@ Contributions are welcome! Please read our `Code of Conduct
9393
<https://github.com/adafruit/Adafruit_CircuitPython_CircuitPython_ADS1x15/blob/master/CODE_OF_CONDUCT.md>`_
9494
before contributing to help this project stay welcoming.
9595

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

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