Skip to content

Commit 596cb62

Browse files
authored
Merge pull request #3 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents b33c0f4 + 03aec72 commit 596cb62

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

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

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