UNIQUE Documentation Deployment to GitHub Pages

[mtdhuynh]

UNIQUE Documentation Deployment to GitHub Pages

This PR adds a GitHub Actions workflow to deploy the (HTML) documentation to GitHub Pages. The target domain will be the default provided by GitHub - username.github.io/repository (i.e., novartis.github.io/unique). At a later point in time, it will be possible to move the documentation to a custom domain (see the docs).

Major Changes

• Added docs.yml with GitHub Actions workflow to build and deploy documentation to GitHub Pages.

Minor Changes

• Updated advanced installation instructions to only use conda instead of mamba in both documentation and in the Makefile. As of conda > 23.10, libmamba is the default solver, removing the need to specifically install mamba to use it. Reverting to conda to make it more user-friendly/accessible.

To Do

• Troubleshoot the default actions/cache action for Jupyter notebook execution caching.

Currently, documentation build takes ~25 minutes due to having to execute the example notebooks. However, the jupyter-cache add-in in myst-nb allows to cache and reuse the execution outputs if the notebooks have not been modified since the last build.

Caching and restoring the execution outputs using the actions/cache action creates a situation whereby the make docs command does not run and says make: 'docs' is up to date.

Being able to cache and reuse the execution outputs can speed up documentation build if notebooks are untouched by current changes. Not critical, but nice to have.

[mtdhuynh]

@gscebba have a look and let me know!