Skip to content

Commit d3438b6

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 69b0131 commit d3438b6

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

114-
Sphinx documentation
115-
-----------------------
116-
117-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
118-
install dependencies (feel free to reuse the virtual environment from above):
119-
120-
.. code-block:: shell
121-
122-
python3 -m venv .env
123-
source .env/bin/activate
124-
pip install Sphinx sphinx-rtd-theme
125-
126-
Now, once you have the virtual environment activated:
127-
128-
.. code-block:: shell
129-
130-
cd docs
131-
sphinx-build -E -W -b html . _build/html
114+
Documentation
115+
=============
132116

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