|
| 1 | +Contributing |
| 2 | +------------ |
| 3 | + |
| 4 | +If you find errors, omissions, inconsistencies or other things that need |
| 5 | +improvement, please create an issue or a pull request at |
| 6 | +https://github.com/sfstoolbox/sfs-matlab/. |
| 7 | +Contributions are always welcome! |
| 8 | + |
| 9 | +Building the Documentation |
| 10 | +^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 11 | + |
| 12 | +If you make changes to the documentation, you can re-create the HTML pages |
| 13 | +using Sphinx_. |
| 14 | +You can install it and a few other necessary packages with:: |
| 15 | + |
| 16 | + python3 -m pip install -r doc/requirements.txt --user |
| 17 | + |
| 18 | +To create the HTML pages, use:: |
| 19 | + |
| 20 | + sphinx-build -b html -d ./_build/doctrees . ./_build/html-preview/ |
| 21 | + |
| 22 | +The generated files will be available in the directory |
| 23 | +``build/sphinx/html-preview/``. |
| 24 | + |
| 25 | +.. _Sphinx: http://sphinx-doc.org/ |
| 26 | + |
| 27 | +Creating a New Release |
| 28 | +^^^^^^^^^^^^^^^^^^^^^^ |
| 29 | + |
| 30 | +New releases are made using the following steps: |
| 31 | + |
| 32 | +#. Bump version number in ``SFS_version.m`` |
| 33 | +#. Update ``NEWS`` |
| 34 | +#. Commit those changes as "Release x.y.z" |
| 35 | +#. Create an (annotated) tag with ``git tag -a x.y.z`` |
| 36 | +#. Check that all author details in ``.zenodo.json`` are correct |
| 37 | +#. Push the commit and the tag to Github and `add release notes`_ containing a |
| 38 | + link to the documentation with http://matlab.sfstoolbox.org/en/x.y.z and the |
| 39 | + bullet points from ``NEWS`` |
| 40 | +#. Check that the new release was built correctly on RTD_, delete the "stable" |
| 41 | + version and select the new release as default version |
| 42 | +#. Check that the new release was registered at Zenodo_ and edit the release |
| 43 | + notes on Github to include the DOI badge |
| 44 | + |
| 45 | +.. _add release notes: https://github.com/sfstoolbox/sfs-matlab/tags |
| 46 | +.. _RTD: http://readthedocs.org/projects/sfs-matlab/builds/ |
| 47 | +.. _Zenodo: https://zenodo.org/search?page=1&size=20&q=sound%20field%20synthesis%20toolbox&sort=bestmatch |
0 commit comments