Skip to content

Commit 1b0e3eb

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 13323a0 commit 1b0e3eb

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

5656

57-
Sphinx documentation
58-
-----------------------
59-
60-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
61-
install dependencies (feel free to reuse the virtual environment from above):
62-
63-
.. code-block:: shell
64-
65-
python3 -m venv .env
66-
source .env/bin/activate
67-
pip install Sphinx sphinx-rtd-theme
68-
69-
Now, once you have the virtual environment activated:
70-
71-
.. code-block:: shell
72-
73-
cd docs
74-
sphinx-build -E -W -b html . _build/html
57+
Documentation
58+
=============
7559

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