Skip to content

mrich316/docker-sphinx-doc-builder

Repository files navigation

Sphinx Documentation Builder

Building the docker image:

docker build -t sphinx-doc-builder .

To see the usage of this container:

docker run -ti --rm --init -v `pwd`:/doc \
  sphinx-doc-builder

Create a new documentation site:

docker run -ti --rm --init -v `pwd`:/doc \
  sphinx-doc-builder sphinx-quickstart

To see build targets:

docker run -ti --rm --init -v `pwd`:/doc \
  sphinx-doc-builder make help

To edit and live-reload the html:

docker run -ti --rm --init -v `pwd`:/doc -p 8000:8000 \
  sphinx-doc-builder make livehtml

Releases

No releases published

Packages

No packages published