Sign inSign up

nickjer/docker-sphinx

By nickjer

•Updated almost 8 years ago

Sphinx documentation builder with extras

Image
1

4.7K

nickjer/docker-sphinx repository overview

⁠Docker Sphinx

Build Status Docker Build Status GitHub License

Docker image for Sphinx⁠.

This image contains:

⁠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

Tag summary

Content type

Image

Digest

Size

954.9 MB

Last updated

almost 8 years ago

docker pull nickjer/docker-sphinx