Skip to content

Commit 2af3fe4

Browse files
authored
Merge pull request #4 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents fc01520 + ac02655 commit 2af3fe4

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

66-
Building locally
67-
================
68-
69-
Zip release files
70-
-----------------
71-
72-
To build this library locally you'll need to install the
73-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
74-
75-
.. code-block:: shell
76-
77-
python3 -m venv .env
78-
source .env/bin/activate
79-
pip install circuitpython-build-tools
80-
81-
Once installed, make sure you are in the virtual environment:
82-
83-
.. code-block:: shell
84-
85-
source .env/bin/activate
86-
87-
Then run the build:
88-
89-
.. code-block:: shell
90-
91-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bmp3xx --library_location .
92-
93-
Sphinx documentation
94-
-----------------------
95-
96-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
97-
install dependencies (feel free to reuse the virtual environment from above):
98-
99-
.. code-block:: shell
100-
101-
python3 -m venv .env
102-
source .env/bin/activate
103-
pip install Sphinx sphinx-rtd-theme
104-
105-
Now, once you have the virtual environment activated:
106-
107-
.. code-block:: shell
108-
109-
cd docs
110-
sphinx-build -E -W -b html . _build/html
66+
Documentation
67+
=============
11168

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