Skip to content

Commit 08a400f

Browse files
authored
Merge pull request #1 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents f56d119 + 1e2caa0 commit 08a400f

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

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

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