Skip to content

Commit f5667a8

Browse files
authored
Removed building locally section from README, replaced with documentation section
1 parent 97d1d63 commit f5667a8

File tree

1 file changed

+3
-46
lines changed

1 file changed

+3
-46
lines changed

README.rst

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -46,50 +46,7 @@ Contributions are welcome! Please read our `Code of Conduct
4646
<https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/blob/master/CODE_OF_CONDUCT.md>`_
4747
before contributing to help this project stay welcoming.
4848

49-
Building locally
50-
================
51-
52-
To build this library locally you'll need to install the
53-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
54-
55-
.. code-block:: shell
56-
57-
python3 -m venv .env
58-
source .env/bin/activate
59-
pip install circuitpython-build-tools
60-
61-
Once installed, make sure you are in the virtual environment:
62-
63-
.. code-block:: shell
64-
65-
source .env/bin/activate
66-
67-
Then run the build:
68-
69-
.. code-block:: shell
70-
71-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-circuitplayground --library_location .
72-
73-
Sphinx documentation
74-
-----------------------
75-
76-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
77-
install dependencies (feel free to reuse the virtual environment from above):
78-
79-
.. code-block:: shell
80-
81-
python3 -m venv .env
82-
source .env/bin/activate
83-
pip install Sphinx sphinx-rtd-theme
84-
85-
Now, once you have the virtual environment activated:
86-
87-
.. code-block:: shell
88-
89-
cd docs
90-
sphinx-build -E -W -b html . _build/html
91-
92-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
93-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
94-
locally verify it will pass.
49+
Documentation
50+
=============
9551

52+
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)