Skip to content

Commit 1641d62

Browse files
authored
Merge pull request #2 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents fa1fd6c + 86ad7cb commit 1641d62

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

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

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