11Contributing
2- ------------
2+ ============
33
44If you find bugs, errors, omissions or other things that need improvement,
55please create an issue or a pull request at
66https://github.com/spatialaudio/python-sounddevice/.
77Contributions are always welcome!
88
9+
10+ Development Installation
11+ ------------------------
12+
913Instead of pip-installing the latest release from PyPI _, you should get the
10- newest development version from Github _::
14+ newest development version (a.k.a. "master") from Github _::
1115
1216 git clone --recursive https://github.com/spatialaudio/python-sounddevice.git
1317 cd python-sounddevice
14- python3 setup.py develop --user
18+ python3 -m pip install -e . --user
1519
1620.. _PyPI : https://pypi.org/project/sounddevice/
1721.. _Github : https://github.com/spatialaudio/python-sounddevice/
1822
1923This way, your installation always stays up-to-date, even if you pull new
2024changes from the Github repository.
2125
22- If you prefer, you can also replace the last command with::
23-
24- python3 -m pip install --user -e .
25-
26- ... where ``-e `` stands for ``--editable ``.
27-
2826Whenever the file ``sounddevice_build.py `` changes (either because you edited it
2927or it was updated by pulling from Github or switching branches), you have to run
3028the last command again.
@@ -35,13 +33,17 @@ If not, you can get the submodule with::
3533
3634 git submodule update --init
3735
36+
37+ Building the Documentation
38+ --------------------------
39+
3840If you make changes to the documentation, you can locally re-create the HTML
3941pages using Sphinx _.
4042You can install it and a few other necessary packages with::
4143
4244 python3 -m pip install -r doc/requirements.txt --user
4345
44- To create the HTML pages , use::
46+ To (re-)build the HTML files , use::
4547
4648 python3 setup.py build_sphinx
4749
0 commit comments