Skip to content

Commit 0b3a939

Browse files
committed
updated README
1 parent cde96ba commit 0b3a939

File tree

1 file changed

+52
-8
lines changed

1 file changed

+52
-8
lines changed

README.rst

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@ Introduction
66
:target: https://circuitpython.readthedocs.io/projects/waveform/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
9+
.. image :: https://img.shields.io/discord/327254708534116352.svg
10+
:target: https://discord.gg/nBQh6qu
11+
:alt: Discord
12+
13+
.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Waveform.svg?branch=master
14+
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Waveform
15+
:alt: Build Status
1216

1317
This library generates simple waveforms that can be used to generate different
1418
type of audio signals.
@@ -40,10 +44,50 @@ Contributions are welcome! Please read our `Code of Conduct
4044
<https://github.com/adafruit/Adafruit_CircuitPython_waveform/blob/master/CODE_OF_CONDUCT.md>`_
4145
before contributing to help this project stay welcoming.
4246

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

49-
api

0 commit comments

Comments
 (0)