Skip to content

Commit 3414690

Browse files
committed
updated README
1 parent cbdd162 commit 3414690

File tree

1 file changed

+45
-9
lines changed

1 file changed

+45
-9
lines changed

README.rst

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ Introduction
66
:target: https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/
77
:alt: Documentation Status
88

9-
.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
10-
:target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
11-
:alt: Gitter
12-
139
.. image :: https://img.shields.io/discord/327254708534116352.svg
1410
:target: https://adafru.it/discord
1511
:alt: Discord
@@ -46,10 +42,50 @@ Contributions are welcome! Please read our `Code of Conduct
4642
<https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/blob/master/CODE_OF_CONDUCT.md>`_
4743
before contributing to help this project stay welcoming.
4844

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

55-
adafruit_circuitplayground/index

0 commit comments

Comments
 (0)