Sphinx-Needs Docker Image¶

Status¶

Image Variants¶

The Sphinx-Needs docker images come in two flavors, each designed for a specific use case.

sphinxneeds:<tag>¶

This is the defacto docker image (size ~ 350MB). If you are not sure about what your requirements are, you probably want to use this one. You can use it as a throw away container (mount your documentation and start the container), as well as the base to build your own docker images.

Included Tools¶

The image is based on sphinx image and includes the following tools.

sphinxneeds-latexpdf:<tag>¶

This docker image includes all the tools in the sphinxneeds:latest image and additionally PDF generation tools. The image is ~ 1.5GB large.

Included Tools¶

The docker image is based on the sphinx latexpdf image and includes the following tools.

Getting Started¶

Prerequisites¶

To use the images, install and configure Docker.

Pulling the Image from Docker Hub¶

The docker image can be pulled by

docker pull danwos/sphinxneeds:latest

or

docker pull danwos/sphinxneeds-latexpdf:latest

A specific version can be pulled with a version tag.

For example,

docker pull danwos/sphinxneeds:0.7.8

Build The Image Locally¶

To build the image locally, execute the following commands.

cd docker && ./build_docker.sh

Usage¶

Linux¶

docker run --rm -it -v $(pwd):/sphinxneeds danwos/sphinxneeds:latest <build-command>

Windows (cmd)¶

docker run --rm -it -v %cd%:/sphinxneeds danwos/sphinxneeds:latest <build-command>

Windows (Powershell)¶

docker run --rm -it -v ${PWD}:/sphinxneeds danwos/sphinxneeds:latest <build-command>

<build-command>s to be used are:

Generate HTML¶

make html

For example,

docker run --rm -it -v $(pwd):/sphinxneeds danwos/sphinxneeds:latest make html

Generate PDF¶

make latexpdf

To enter a shell, execute:

Linux¶

docker run --rm -it -v $(pwd):/sphinxneeds danwos/sphinxneeds:latest bash

Windows (cmd)¶

docker run --rm -it -v %cd%:/sphinxneeds danwos/sphinxneeds:latest bash

Windows (Powershell)¶

docker run --rm -it -v ${PWD}:/sphinxneeds danwos/sphinxneeds:latest bash

Once inside the docker container shell, you can execute docs build command