Skip to content

Commit a6c48ee

Browse files
authored
Merge pull request #17 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 98fa538 + e8d145a commit a6c48ee

File tree

1 file changed

+3
-44
lines changed

1 file changed

+3
-44
lines changed

README.rst

+3-44
Original file line numberDiff line numberDiff line change
@@ -89,49 +89,8 @@ Contributions are welcome! Please read our `Code of Conduct
8989
<https://github.com/adafruit/Adafruit_CircuitPython_bmp280/blob/master/CODE_OF_CONDUCT.md>`_
9090
before contributing to help this project stay welcoming.
9191

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

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

0 commit comments

Comments
 (0)