Skip to content

πŸ‹ πŸ“š The most featured Docker image for Sphinx, a documentation tool written in Python.

Notifications You must be signed in to change notification settings

minidocks/sphinx-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

51 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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

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

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

Extensions

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

More extensions on

Tools

Markdown support

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

Alternatives

About

πŸ‹ πŸ“š The most featured Docker image for Sphinx, a documentation tool written in Python.

Topics

Resources

Stars

Watchers

Forks