Skip to content

Commit d58b735

Browse files
authored
Merge pull request #3 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 45f6498 + def5b42 commit d58b735

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

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

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