Skip to content

Commit 739ba34

Browse files
authored
Merge pull request #3 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents deccffd + 00bfb98 commit 739ba34

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

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

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