Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Commit a738f4a

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 47c2381 commit a738f4a

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
@@ -42,25 +42,7 @@ Contributions are welcome! Please read our `Code of Conduct
4242
before contributing to help this project stay welcoming.
4343

4444

45-
Sphinx documentation
46-
-----------------------
47-
48-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
49-
install dependencies (feel free to reuse the virtual environment from above):
50-
51-
.. code-block:: shell
52-
53-
python3 -m venv .env
54-
source .env/bin/activate
55-
pip install Sphinx sphinx-rtd-theme
56-
57-
Now, once you have the virtual environment activated:
58-
59-
.. code-block:: shell
60-
61-
cd docs
62-
sphinx-build -E -W -b html . _build/html
45+
Documentation
46+
=============
6347

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