Docker Sphinx

Docker image for Sphinx.

This image contains:

• Sphinx
• A theme:
  • sphinx_rtd_theme
• A variety of plugins:
  • sphinxcontrib-plantuml
  • sphinxcontrib-httpdomain

Build

git clone https://github.com/OSC/docker-sphinx.git
cd docker-sphinx
docker build --force-rm -t ohiosupercomputer/docker-sphinx .

Install

docker pull ohiosupercomputer/docker-sphinx

Usage

docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" ohiosupercomputer/docker-sphinx <cmd>

Docker Compose

It is recommended to use Docker Compose. An example docker-compose.yml is seen as:

version: "2"
services:
  sphinx:
    image: "ohiosupercomputer/docker-sphinx"
    volumes:
      - "${PWD}:/doc"
    user: "1000:1000"

Then run:

docker-compose run --rm sphinx <cmd>

Examples:

docker-compose run --rm sphinx sphinx-quickstart
docker-compose run --rm sphinx make html