riptidepy/sphinx repository overview

⁠Supported tags and respective Dockerfile links

• latest (Dockerfile)⁠

⁠Quick reference

• Where to get help: the Riptide Docker Images Github Repository⁠

• Where to file issues: https://github.com/theCapypara/riptide-docker-images/issues⁠

• Maintained by: the Riptide Community⁠

• Source of this description: README in riptide-docker-images repo⁠ (history⁠)

⁠What is sphinx?

Sphinx is a tool for building documentations. More information can be found on the [http://www.sphinx-doc.org/en/master/](Sphinx⁠ homepage).

This image includes the latest version of

• sphinx
• sphinx-autobuild
• sphinx_rtd_theme

⁠How to use this image.

The default command runs sphinx-autobuild and insalls some requirements before this.

Default working directory is /src.

This image is meant to be used with Riptide⁠. Using it without Riptide is probably possible, but not supported.

⁠Basic Usage with Riptide

See the community repository entry for https://github.com/theCapypara/riptide-repo/tree/master/app/sphinx/latest.yml⁠.

This image supports run_as_current_user: true for services (this is the default).

⁠Basic Usage with Docker Run

docker run -p 8000:8000 \
       -v "$(pwd):/src" \
       --user "$(id -u)" \
       riptidepy/sphinx

This will start sphinx_autobuild and bind it to the local port 8000.

⁠Environment Variables