Skip to content

Commit c9a77aa

Browse files
authored
Merge pull request #5 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents dbd0dc9 + cf112ef commit c9a77aa

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

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

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