If you find errors, omissions, inconsistencies or other things that need improvement, please create an issue or a pull request at https://github.com/sfstoolbox/theory/. Contributions are always welcome!
In order to build the theory section locally you should get the newest development version from Github and install the needed dependencies with:
git clone https://github.com/sfstoolbox/theory.git cd theory python3 -m pip install --user -r requirements.txt
If you make changes to the documentation, you can re-create the HTML and PDF pages using Sphinx.
To create the HTML pages, use:
make html-preview
The generated files will be available in the directory
_build/sphinx/html-preview/.
To create the PDF pages, use:
make latexpdf
The generated files will be available in the directory _build/sphinx/latex/.
New releases are made using the following steps:
- Update
NEWS.rst - Commit those changes as "Release x.y.z"
- Create an (annotated) tag with
git tag -a x.y.z - Push the commit and the tag to Github and add release notes containing
the bullet points from
NEWS.rst - Check that the new release was built correctly on RTD, and select the new release as default version
The following individuals have contributed significantly to the Sound Field Synthesis Toolbox. If you think more people should be listed here, feel free to create a pull request.
| Name | GitHub |
|---|---|
| Hagen Wierstorf | hagenw |
| Fiete Winter | fietew |
| Matthias Geier | mgeier |
| Frank Schultz | fs446 |
| Nara Hahn | narahahn |
| Till Rettberg | trettberg |
| Christoph Hold | chris-hld |
| Vera Erbes | VeraE |
| Sascha Spors | spors |
Furthermore, all github contributions can be found on the specific project pages: