gwerlas/sphinx repository overview

⁠Sphinx

Container image with sphinx⁠ command line tools.

GitLab Project : yoanncolin/container-images/sphinx⁠.

⁠Tags

• 8.2.3⁠, 8.2⁠, 8⁠
• 8.1.3⁠, 8.1⁠
• 7.4.7⁠, 7.4⁠, 7⁠
• 7.3.7⁠, 7.3⁠
• 7.2.6⁠, 7.2⁠
• 7.1.2⁠, 7.1⁠
• 6.2.1⁠, 6.2⁠, 6⁠
• 5.3.0⁠, 5.3⁠, 5⁠
• 3.4.3⁠, 3.4⁠, 3⁠

⁠Usage

Show the version number or the help of sphinx-build :

docker run gwerlas/sphinx sphinx-build --version
docker run gwerlas/sphinx sphinx-build --help

The container runs as the sphinx user (non-root). When mounting a local directory, make sure it is readable and writable by that user, or pass your own UID/GID.

With Docker :

docker run \
  --user $(id -u):$(id -g) \
  -v $(pwd):/home/sphinx \
  gwerlas/sphinx \
  make html

With Podman (rootless), combine --userns=keep-id (UID namespace mapping) and --user (process UID) so the process can write to the mounted volume :

podman run \
  --userns=keep-id \
  --user $(id -u):$(id -g) \
  -v $(pwd):/home/sphinx \
  gwerlas/sphinx \
  make html

⁠Embedded tools

Depending of you documentation usage, You may need some tools to be embedded to the image.

Here are the current embedded tools inside this image :

• ca-certificates configured for intersphinx mapping
• git+ssh for Git submodules
• babel
• graphviz
• hieroglyph
• make
• rstcheck
• texlive
• yaml2rst

⁠Themes

Here are the available themes⁠ :

• PyData
• Read the docs

⁠Use your own CA

If your own CA certificate is installad on your host's CA bundle, You can just mount it in the container.

For example, on Fedora :

local_ca=/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem
docker run -v $local_ca:/etc/ssl/certs/ca-certificates.crt:ro gwerlas/sphinx ...

Otherwise You can extend the image with your own CA bundle. Here is an exemple of Dockerfile :

FROM gwerlas/sphinx

COPY files/*.crt /usr/local/share/ca-certificates/
RUN update-ca-certificates

⁠License

BSD 3-Clause License⁠.