Skip to content

Commit ad4a6a6

Browse files
authored
Merge pull request #18 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents d209c7c + 7752e43 commit ad4a6a6

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -96,49 +96,7 @@ Contributions are welcome! Please read our `Code of Conduct
9696
<https://github.com/adafruit/Adafruit_CircuitPython_sgp30/blob/master/CODE_OF_CONDUCT.md>`_
9797
before contributing to help this project stay welcoming.
9898

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

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