Skip to content

Commit ab15746

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 0917e00 commit ab15746

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

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

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