Skip to content

Commit c398a04

Browse files
authored
Merge pull request #20 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents bcb636f + b722de3 commit c398a04

File tree

1 file changed

+3
-22
lines changed

1 file changed

+3
-22
lines changed

README.rst

+3-22
Original file line numberDiff line numberDiff line change
@@ -78,26 +78,7 @@ Contributions are welcome! Please read our `Code of Conduct
7878
<https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH/blob/master/CODE_OF_CONDUCT.md>`_
7979
before contributing to help this project stay welcoming.
8080

81-
Building locally
82-
================
83-
84-
To build this library locally you'll need to install the
85-
`circuitpython-travis-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
86-
87-
.. code-block::shell
88-
89-
python3 -m venv .env
90-
source .env/bin/activate
91-
pip install -r requirements.txt
92-
93-
Once installed, make sure you are in the virtual environment:
94-
95-
.. code-block::shell
96-
97-
source .env/bin/activate
98-
99-
Then run the build:
100-
101-
.. code-block::shell
81+
Documentation
82+
=============
10283

103-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lis3dh --library_location .
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)