webuni/sphinx-doc repository overview
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
More themes on https://sphinx-themes.org/.
Extensions
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.
- ReStructuredText validator rstvalidator.
Markdown support
Usage
Create own image with custom theme:
FROM minidocks/sphinx-doc
RUN pip install sphinx_rtd_theme && clean
Generate a new documentation:
docker run --rm -it -v `pwd`:/doc -w /doc minidocks/sphinx-doc sphinx-quickstart .
And run documentation server:
docker run --rm -v `pwd`:/doc -w /doc -p 8000:8000 minidocks/sphinx-doc sphinx-autobuild -H 0.0.0.0 . _build/
Configuration
Tags
| Tag | Size |
|---|---|
| latest, 3 |  |
| 3 |  |
Alternatives
Tag summary
Content type
Image
Digest
Size
39.7 MB
Last updated
over 5 years ago
docker pull webuni/sphinx-doc