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/sfs-matlab/. Contributions are always welcome!
If you make changes to the documentation, you can re-create the HTML pages using Sphinx. You can install it and a few other necessary packages with:
python3 -m pip install -r doc/requirements.txt --user
To create the HTML pages, use:
sphinx-build -b html -d ./_build/doctrees . ./_build/html-preview/
The generated files will be available in the directory
build/sphinx/html-preview/.
New releases are made using the following steps:
- Bump version number in
SFS_version.m - Update
NEWS - Commit those changes as "Release x.y.z"
- Create an (annotated) tag with
git tag -a x.y.z - Check that all author details in
.zenodo.jsonare correct - Push the commit and the tag to Github and add release notes containing a
link to the documentation with https://sfs-matlab.readthedocs.io/en/x.y.z and
the bullet points from
NEWS - Check that the new release was built correctly on RTD, delete the "stable" version and select the new release as default version
- Check that the new release was registered at Zenodo and edit the release notes on Github to include the DOI badge