Skip to content

Commit 221f58a

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent ccfe4b7 commit 221f58a

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

README.rst

+3-21
Original file line numberDiff line numberDiff line change
@@ -65,25 +65,7 @@ Contributions are welcome! Please read our `Code of Conduct
6565
<https://github.com/adafruit/Adafruit_CircuitPython_Requests/blob/master/CODE_OF_CONDUCT.md>`_
6666
before contributing to help this project stay welcoming.
6767

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

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