Skip to content

Commit 0943c67

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent a0c3a28 commit 0943c67

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

96-
Sphinx documentation
97-
-----------------------
98-
99-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
100-
install dependencies (feel free to reuse the virtual environment from above):
101-
102-
.. code-block:: shell
103-
104-
python3 -m venv .env
105-
source .env/bin/activate
106-
pip install Sphinx sphinx-rtd-theme
107-
108-
Now, once you have the virtual environment activated:
109-
110-
.. code-block:: shell
111-
112-
cd docs
113-
sphinx-build -E -W -b html . _build/html
96+
Documentation
97+
=============
11498

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