Skip to content

Commit 337e07a

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 1a3e2a3 commit 337e07a

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
@@ -71,25 +71,7 @@ Contributions are welcome! Please read our `Code of Conduct
7171
<https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT/blob/master/CODE_OF_CONDUCT.md>`_
7272
before contributing to help this project stay welcoming.
7373

74-
Sphinx documentation
75-
-----------------------
76-
77-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
78-
install dependencies (feel free to reuse the virtual environment from above):
79-
80-
.. code-block:: shell
81-
82-
python3 -m venv .env
83-
source .env/bin/activate
84-
pip install Sphinx sphinx-rtd-theme
85-
86-
Now, once you have the virtual environment activated:
87-
88-
.. code-block:: shell
89-
90-
cd docs
91-
sphinx-build -E -W -b html . _build/html
74+
Documentation
75+
=============
9276

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