Skip to content

Commit d4daa76

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 385532b commit d4daa76

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

README.rst

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -79,25 +79,7 @@ Contributions are welcome! Please read our `Code of Conduct
7979
<https://github.com/adafruit/Adafruit_CircuitPython_MPU6050/blob/master/CODE_OF_CONDUCT.md>`_
8080
before contributing to help this project stay welcoming.
8181

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

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