ifilot / docker-sphinx-qm

Docker image for compiling Sphinx documentation including support for quantum chemical packages

Sphinx Docker image

Purpose

This Docker image extends the Sphinx docker image with a number of relevant quantum-chemical packages.

List of available Python packages

• pyqint
• pytessel
• sphecerix
• pylebedev
• pydft

Usage

Ensure a copy of the docker image is present

docker pull ghcr.io/ifilot/sphinx-qm:v0.3.0

To compile the Sphinx documentation locally, run

docker run --volume ./docs:/data/docs --workdir /data/docs -it ghcr.io/ifilot/sphinx-qm:v0.3.0 make html