README.md

Sphinx docker image (minidocks/sphinx-doc)

Sphinx is a documentation generator that converts reStructuredText files into HTML websites and other formats including PDF, EPub, Texinfo and man.

reStructuredText is extensible, and Sphinx exploits its extensible nature through a number of extensions – for autogenerating documentation from source code, writing mathematical notation or highlighting source code, etc.

Installed extensions

Themes

• Awesome
• Book
• Documatt
• Furo
• Immaterial
• Material
• Pallets
• Press
• PyData
• Read the Docs

Pdf themes (only minidocks/sphinx-doc:*-pdf)

• Business

More themes on https://sphinx-themes.org/.

Extensions

• Comments
• Confluence Builder
• Copy button
• Design
• Inline tabs
• Kroki
• Multiversion
• OpenAPI
• Panels
• Prompt
• Sitemap
• Tabs
• Toolbox

Pdf extensions (only minidocks/sphinx-doc:*-pdf)

• rst2pdf
• WeasyPrint

More extensions on

• https://sphinxext-survey.readthedocs.io/en/latest/
• https://github.com/sphinx-contrib
• https://sphinx-extensions.readthedocs.io/en/latest/
• https://github.com/yoloseem/awesome-sphinxdoc

Tools

• Multiple sources support included via sphinx-multibuild.
• Live-reload web server provided by sphinx-autobuild.
• A tool for converting ReStructuredText to MyST Markdown rst-to-myst

Markdown support

• Markdown parser
• MInclude
• Markdown builder
• MyST

Usage

Generate a new documentation:

docker run --rm -it -v `pwd`:/doc -w /doc minidocks/sphinx-doc sphinx-quickstart .

Run a documentation server:

docker run --rm -v `pwd`:/doc -w /doc -p 8000:8000 minidocks/sphinx-doc sphinx-autobuild -H 0.0.0.0 . _build/

Custom docker image

Create own image with a custom theme:

FROM minidocks/sphinx-doc

RUN pip install sphinx_rtd_theme && clean

Tags

Tag	Size
latest, 4
pdf
4
4-pdf

Related images

• MkDocs

Alternatives

• https://github.com/keimlink/docker-sphinx-doc