Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 561 Bytes

README.md

File metadata and controls

26 lines (18 loc) · 561 Bytes

SPHINX Quickstart

container to generate SPHINX documentation. Will output HTML and PDF

Build the container with:


    docker build -t sphinx_image .

the input folder should contain the project documentation.

The output folder should be empty. Existing content may be overwritten!

Run the container with


    docker run --name sphinx --rm \
    -e "Project=Sphinx in a docker" \
    -e "Author=Till Witt" \
    -e "Version=v1.0" \
    -v "$(pwd)/input:/project/input" \
    -v "$(pwd)/output:/project/output" \
        -i -t sphinx_image