README.md

sphinx-doc

Docker image for building documentation via Sphinx.

This image has been primarily created for generating PDF documentation via LaTeX, but may support other builders as well.

If you have a need to use it with a builder that is currently not supported by this Docker image feel free to open a PR that adds the necessary packages.

Usage

docker run -v <docs-directory>:/docs benjixx/sphinx-doc make <sphinx-make-target>

Examples

Create HTML documentation:

docker run -v path/to/your/sphinx/docs:/docs benjixx/sphinx-doc make html

Create PDF documentation with the help of LaTeX:

docker run -v path/to/your/sphinx/docs:/docs benjixx/sphinx-doc make latexpdf