Next step: Read the Docs

[github-actions]

Your Python package should have publicly available documentation, including API documentation for your users.
Read the Docs can host your user documentation for you.

To host the documentation of this repository please perform the following instructions:

1. go to Read the Docs
2. log in with your GitHub account
3. find NLESC-JCER/qmcflow in list and press + button.
   • If repository is not listed,
     1. go to Read the Docs GitHub app
     2. make sure NLESC-JCER has been granted access.
     3. reload repository list on Read the Docs import page
4. wait for the first build to be completed at https://readthedocs.org/projects/qmcflow/builds
5. check that the link of the documentation badge in the README.md works

See README.dev.md# how to build documentation site locally.