Skip to content

Commit 075731b

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 29fd429 commit 075731b

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

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

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