nickjer/docker-sphinx

Sphinx documentation builder with extras in a Docker container

Docker Sphinx

Docker image for Sphinx.

This image contains:

• Sphinx
• A variety of themes:
  • Alabaster
  • Sphinx Bootstrap Theme
  • sphinx_rtd_theme
• A markdown parser for reStructuredText (recommonmark)
• A sphinx watcher tool (sphinx-autobuild)
• A variety of plugins:
  • sphinx-prompt
  • sphinxcontrib-actdiag
  • sphinxcontrib-blockdiag
  • sphinxcontrib-nwdiag
  • sphinxcontrib-seqdiag
  • sphinxcontrib-plantuml
  • sphinxcontrib-exceltable
  • sphinxcontrib-googleanalytics
  • sphinxcontrib-googlechart
  • sphinxcontrib-googlemaps
  • sphinxcontrib-httpdomain
• Latex to generate PDF documents

Build

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

Install

docker pull nickjer/docker-sphinx

Usage

docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" nickjer/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: "nickjer/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