docker-sphinx

Docker images for Sphinx.

Images

• alphacodinghub/sphinx-latexpdf

Note: This image is based on official image, added more themes and packages.

alphacodinghub/sphinx-latexpdf contains TeXLive packages.

Usage

Create a Sphinx project::

$ docker run --rm -v /path/to/document:/docs alphacodinghub/sphinx sphinx-quickstart

if you work in the current directory, you can use:

$ docker run --rm -v $PWD:/docs alphacodinghub/sphinx-latexpdf sphinx-quickstart

To access to the Docker container:

$ docker run --rm -it -v $PWD:/docs alphacodinghub/sphinx-latexpdf bash

Build HTML document::

$ docker run --rm -v /path/to/document:/docs alphacodinghub/sphinx-latexpdf make html

Build EPUB document::

$ docker run --rm -v /path/to/document:/docs alphacodinghub/sphinx-latexpdf make epub

Build PDF document::

$ docker run --rm -v /path/to/document:/docs alphacodinghub/sphinx-latexpdf make latexpdf

Tips 1

If you would like to install dependencies, use alphacodinghub/sphinx as a base image::

# in your Dockerfile
FROM alphacodinghub/sphinx

WORKDIR /docs
ADD requirements.txt /docs
RUN pip3 install -r requirements.txt

Tips 2

It is recommended that you log into the docker container, check the container's IP address, run the auto-build command as follows:

$ docker run --rm -it -v $PWD:/docs alphacodinghub/sphinx-latexpdf bash
$ ip address show
$ sphinx-autobuild  .  _build/html -H 0.0.0.0

You can then live view the document output by accessing to the container:

$ http://<container's IP address>:8000

References

• docker-sphinx