KengoTODA / sphinx-docker

docker-sphinx

Docker image for Sphinx build.

Images

• tk0miya/sphinx-base
• tk0miya/sphinx-base-pdf
• tk0miya/sphinx-html
• tk0miya/sphinx-epub
• tk0miya/sphinx-pdf

Note

tk0miya/sphinx-pdf contains TeXLive packages. So the image is very large (over 2GB!).

Usage

Build HTML document:

$ docker run --rm -v /path/to/document:/docs tk0miya/sphinx-html

Build EPUB document:

$ docker run --rm -v /path/to/document:/docs tk0miya/sphinx-epub

Build PDF document:

$ docker run --rm -v /path/to/document:/docs tk0miya/sphinx-pdf

Tips

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

# in your Dockerfile
FROM tk0miya/sphinx-base

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