f5devcentral/containthedocs repository overview

⁠Overview

This image is based on alpine. It contains the basic dependencies needed to build documentation with Sphinx. The f5-sphinx-theme⁠ is built in.

⁠Usage

docker run --rm -it f5devcentral/containthedocs:latest

⁠Versions:

Beginning with v1.0.4, versions correspond to the version of the f5-sphinx-theme included in the image.

• latest - includes the latest version of f5-sphinx-theme
• 1.0.8 - includes v1.0.9 of f5-sphinx-theme
  • Added sphinx extensions intended for building graphs and diagrams: sphinxcontrib-blockdiag sphinxcontrib-nwdiag
  • Added sphinxcontrib-addmetahtml extension
  • Added graphviz utility
  • Removed Python2.7; only Python3.6 is included
• 1.0.6 - includes v1.0.6 of f5-sphinx-theme

⁠Built-in deployment scripts

The image contains a /tools directory containing a number of scripts used to deploy documentation from GitHub/GitLab project repos to an AWS s3 bucket configured for static website hosting. These scripts are specific to F5's deployment requirements but can be amended (and committed as a new image) to suit your needs.