bwibo/sphinx-rtd repository overview

⁠Docker image for Sphinx and ReadTheDocs

Dockerfile for Sphinx⁠ including following extensions:

• Sphinx ReadTheDocs Theme: sphinx_rtd_theme⁠
• Copy button sphinx_copybutton⁠
• Sphinx emojies sphinxemoji⁠

The image is available on DockerHub: https://hub.docker.com/repository/docker/bwibo/sphinx-rtd⁠

⁠Usage

Mount your local docs folder to /docs inside the container and append the command you want to use. More info on the available commands is available in the documentation of the base image: https://hub.docker.com/r/sphinxdoc/sphinx⁠

# Build HTML docs
docker run --rm \
    -v $PWD:/docs \
  bwibo/sphinx-rtd make html

⁠Build

Run build.sh to build the image or:

DOCKER_BUILDKIT=1 \
docker build -t bwibo/sphinx-rtd --build-arg BASEIMAGE_TAG=4.1.1 .