Skip to content

Commit f3bd752

Browse files
authored
Merge pull request #6 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 7a999c4 + 3777131 commit f3bd752

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

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

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