Skip to content

Commit a68b03c

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent c49ae90 commit a68b03c

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -51,52 +51,7 @@ Contributions are welcome! Please read our `Code of Conduct
5151
<https://github.com/adafruit/Adafruit_CircuitPython_VEML6075/blob/master/CODE_OF_CONDUCT.md>`_
5252
before contributing to help this project stay welcoming.
5353

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

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