Sign inSign up

driller/sphinx

By driller

Updated over 6 years ago

forked from tk0miya/sphinx-docker

Image
0

289

driller/sphinx repository overview

docker-sphinx

Docker image for Sphinx build.

Images

  • driller/sphinx:base
  • driller/sphinx:pdf

note:

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

Usage

Create a Sphinx project::

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

Build HTML document::

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

Build EPUB document::

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

Build PDF document::

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

Build HTML document with specified version::

$ docker run --rm -v /path/to/document:/docs driller/sphinx:2.3 make html

Build EPUB document with specified version::

$ docker run --rm -v /path/to/document:/docs driller/sphinx:2.3 make epub

Build

$ docker run --rm -v /path/to/document:/docs driller/sphinx:pdf2.3 make latexpdf

Tips

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

# in your Dockerfile
FROM driller/sphinx:base

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

Tag summary

Content type

Image

Digest

Size

171.4 MB

Last updated

over 6 years ago

docker pull driller/sphinx