Skip to content

Commit 454fe8a

Browse files
authored
Merge pull request #4 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents fcbdd57 + d33c2e3 commit 454fe8a

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

README.rst

+3-21
Original file line numberDiff line numberDiff line change
@@ -84,25 +84,7 @@ Contributions are welcome! Please read our `Code of Conduct
8484
<https://github.com/adafruit/Adafruit_CircuitPython_SSD1322/blob/master/CODE_OF_CONDUCT.md>`_
8585
before contributing to help this project stay welcoming.
8686

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

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