Sphinx

Container image with the Sphinx static site generator.

Image Tags

• latest: Latest stable version of the container currently based on Python 3.10.1 and Sphinx 6.2.1.

How to Build

This image is built on GitHub automatically any time a commit is made or merged to the main branch and tagged. But if you need to build the image on your own locally, do the following:

1. Install Podman.

2. cd into the directory containing this repository.

3. Build the image:

   podman build --file Containerfile --tag container-sphinx:latest .

How to Use

1. Install Podman.

2. Pull this image from GitHub (or use the image you built above container-sphinx:latest):

   podman pull ghcr.io/chpc-uofu/container-sphinx:latest

3. Run a container from the image:

   podman run \
     -it \
     --privileged \
     --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro \
     ghcr.io/chpc-uofu/container-sphinx:latest \
     bash

How to Contribute

1. Submit a pull request against main.
2. Once the automated status checks pass, complete the pull request by squash-merging with main.
3. Apply a semantic version tag to the resulting commit (e.g. v1.0.1).
4. At this point the automatic image build on GitHub will trigger, tagging the new image with the semantic version and latest.

Resources

• Sphinx: Getting Started