Sign inSign up

bakchoy/sphinx

By bakchoy

Updated over 9 years ago

Run Sphinx in a container

Image
0

1.6K

bakchoy/sphinx repository overview

This provides an easy way to run Sphinx (http://www.sphinx-doc.org). Instead of having to mess with getting the correct version of Python, pip, Sphinx, etc., everything comes packaged nicely in an Image. Your source and build directories can be mounted as volumes and the container will do the work.

Commands include:

  • sphinx-apidoc
  • sphinx-autogen
  • sphinx-build
  • sphinx-quickstart

Examples:

docker run -v docs:/docs:rw bakchoy/sphinx sphinx-apidoc -e -o /docs/source/_modules /docs/source/_pythonFiles

docker run -v docs:/docs:rw bakchoy/sphinx sphinx-build -M html /docs/source /docs/build

Python Version 2.7.13 Sphinx Version 1.5.1

Tag summary

Content type

Image

Digest

Size

48 MB

Last updated

over 9 years ago

docker pull bakchoy/sphinx