This image is based on ubuntu. It contains the basic dependencies needed to build documentation with Sphinx.
The f5-sphinx-theme is built in.
docker run --rm -it -v $PWD:$PWD --workdir $PWD -e "LOCAL_USER_ID=$(id -u)" containthedocs "$@"
- latest - Ubuntu 16.04-based image; continually updated
- latex_pdf - Same as latest, but with LaTeX packages built in. Much bigger download.
- 1.0 - Snapshot of latest at commit 52e6f6f9 in containthedocs project, which is prior to integration of f5-sphinx-theme v1.0.0.
FROM ubuntu:xenial ENV APPPATH /wkdir WORKDIR /wkdir RUN set -x \ && apt-get update \ && apt-get install -y \ build-essential \ git \ libssl-dev \ libffi-dev \ nodejs-legacy \ npm \ python-dev \ python-pip \ curl \ wget \ sudo \ && rm -rf /var/lib/apt/lists/* RUN npm install -g write-good \ npm install -g broken-link-checker \ npm install -g jsdoc COPY requirements.txt /tmp RUN pip2 install -U pip \ && pip2 install -r /tmp/requirements.txt COPY entrypoint.sh / COPY tools/* /usr/local/bin/ ENTRYPOINT [ "/entrypoint.sh" ] CMD [ "/bin/bash" ]
sphinx>=1.6.5 recommonmark awscli sphinx-autobuild git+https://github.com/f5devcentral/f5-sphinx-theme.git@master cloud_sptheme sphinxjp.themes.basicstrap virtualenv boto3 sphinx-js
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.