Skip to content

Commit 4642333

Browse files
authored
Merge pull request #13 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documenta…
2 parents 0808605 + 7856352 commit 4642333

File tree

1 file changed

+3
-48
lines changed

1 file changed

+3
-48
lines changed

README.rst

+3-48
Original file line numberDiff line numberDiff line change
@@ -88,52 +88,7 @@ Contributions are welcome! Please read our `Code of Conduct
8888
<https://github.com/adafruit/Adafruit_CircuitPython_turtle/blob/master/CODE_OF_CONDUCT.md>`_
8989
before contributing to help this project stay welcoming.
9090

91-
Building locally
92-
================
93-
94-
Zip release files
95-
-----------------
96-
97-
To build this library locally you'll need to install the
98-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
99-
100-
.. code-block:: shell
101-
102-
python3 -m venv .env
103-
source .env/bin/activate
104-
pip install circuitpython-build-tools
105-
106-
Once installed, make sure you are in the virtual environment:
107-
108-
.. code-block:: shell
109-
110-
source .env/bin/activate
111-
112-
Then run the build:
113-
114-
.. code-block:: shell
115-
116-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-turtle --library_location .
117-
118-
Sphinx documentation
119-
-----------------------
120-
121-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
122-
install dependencies (feel free to reuse the virtual environment from above):
123-
124-
.. code-block:: shell
125-
126-
python3 -m venv .env
127-
source .env/bin/activate
128-
pip install Sphinx sphinx-rtd-theme
129-
130-
Now, once you have the virtual environment activated:
131-
132-
.. code-block:: shell
133-
134-
cd docs
135-
sphinx-build -E -W -b html . _build/html
91+
Documentation
92+
=============
13693

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