Skip to content

Commit 638e771

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 53146ab commit 638e771

File tree

1 file changed

+3
-45
lines changed

1 file changed

+3
-45
lines changed

README.rst

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -41,49 +41,7 @@ Contributions are welcome! Please read our `Code of Conduct
4141
<https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH/blob/master/CODE_OF_CONDUCT.md>`_
4242
before contributing to help this project stay welcoming.
4343

44-
Building locally
45-
================
46-
47-
To build this library locally you'll need to install the
48-
`circuitpython-travis-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
49-
50-
.. code-block::shell
51-
52-
python3 -m venv .env
53-
source .env/bin/activate
54-
pip install -r requirements.txt
55-
56-
Once installed, make sure you are in the virtual environment:
57-
58-
.. code-block::shell
59-
60-
source .env/bin/activate
61-
62-
Then run the build:
63-
64-
.. code-block::shell
65-
66-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lis3dh --library_location .
67-
68-
Sphinx documentation
69-
-----------------------
70-
71-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
72-
install dependencies (feel free to reuse the virtual environment from above):
73-
74-
.. code-block:: shell
75-
76-
python3 -m venv .env
77-
source .env/bin/activate
78-
pip install Sphinx sphinx-rtd-theme
79-
80-
Now, once you have the virtual environment activated:
81-
82-
.. code-block:: shell
83-
84-
cd docs
85-
sphinx-build -E -W -b html . _build/html
44+
Documentation
45+
=============
8646

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