Skip to content

Commit 787bc75

Browse files
authored
Merge pull request #3 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 2625da1 + c59b33f commit 787bc75

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

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

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