Skip to content

Commit 7a55eee

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 16a7a1b commit 7a55eee

File tree

1 file changed

+3
-46
lines changed

1 file changed

+3
-46
lines changed

README.rst

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -56,50 +56,7 @@ Contributions are welcome! Please read our `Code of Conduct
5656
<https://github.com/adafruit/Adafruit_CircuitPython_LSM303_Accel/blob/master/CODE_OF_CONDUCT.md>`_
5757
before contributing to help this project stay welcoming.
5858

59-
Building locally
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-lsm303-accel --library_location .
82-
83-
84-
Sphinx documentation
85-
-----------------------
86-
87-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
88-
install dependencies (feel free to reuse the virtual environment from above):
89-
90-
.. code-block:: shell
91-
92-
python3 -m venv .env
93-
source .env/bin/activate
94-
pip install Sphinx sphinx-rtd-theme
95-
96-
Now, once you have the virtual environment activated:
97-
98-
.. code-block:: shell
99-
100-
cd docs
101-
sphinx-build -E -W -b html . _build/html
59+
Documentation
60+
=============
10261

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