pyMBE-dev / pyMBE

pyMBE provides tools to facilitate building up molecules with complex architectures in the Molecular Dynamics software ESPResSo. For an up-to-date API documention please check our website:
https://pymbe-dev.github.io/pyMBE/pyMBE.html
GNU General Public License v3.0
6 stars 8 forks source link

Build and deploy documentation with CI/CD pipeline #23

Closed jngrad closed 5 months ago

jngrad commented 5 months ago

The documentation is now built as part of the CI and uploaded to an artifact. Broken docstrings will fail CI. When a PR is merged, the artifacts are downloaded and deployed to the GitHub Pages at https://pm-blanco.github.io/pyMBE.

jngrad commented 5 months ago

Note to reviewers:

jngrad commented 5 months ago

@pm-blanco To enable GitHub Pages, go to this repository "Settings", under "Code and automation" click "Pages", under "Build and deployment" select "GitHub Actions". Then you could can merge this PR; a testsuite workflow will start on the main branch, and once it completes successfully, it will send a signal to start the deploy workflow, which will fetch the status of the testsuite and download its HTML files, then upload them to the Pages.

We can then add https://pm-blanco.github.io/pyMBE to the manuscript. Note that the link automatically redirects to a subpage, which is the expected behavior from pdoc (it generates an index.html landing page), and I would recommend not writing the subpage URL in the manuscript, because this link would break if we re-organize the pyMBE tree structure. Currently https://pm-blanco.github.io returns a 404 because you do not have a personal page, but as far as I can tell, this has no consequence on the user guide.