How to contribute to the documentation of PUMI:
Check out the branch
docs-test.Modify the contents of the Docs folder. E.g. add a new markdown file (
new.md) for a new page and update index.rst accordingly (add link tonew.html) Refer to the sphinx documentation for details.Commit and push back to
docs-test.Navigate to https://pumi.readthedocs.io/en/docs-test/ Your changes will be rendered in a few minutes. (You can monitor the progress here: https://readthedocs.org/projects/pumi/builds/)
Create a pull request to the main branch to make it official and appear in https://pumi.readthedocs.io/en/latest.
Thank you for contributing!