Skip to content

Commit 33c2d51

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 33b8118 commit 33c2d51

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

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

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