skyzyx/alpine-pandoc


Docker container with Alpine Linux, Pandoc, PlantUML, and Sphinx.

https://hub.docker.com/r/skyzyx/alpine-pandoc/

Language: Makefile

Keywords: alpine-linux, container, docker, documentation, haskell, java, pandoc, plantuml, python, sphinx


alpine-pandoc

This is the source code which builds a Docker container comprised of Alpine Linux, Pandoc, PlantUML, and Sphinx. It is intended to provide an environment which is optimized for generating documentation.

We use:

Building the Container

make

Consuming the Container

The short version is FROM skyzyx/alpine-pandoc:1.0.0.

  1. Compiling Pandoc takes some time, so using this container saves you that time.
  2. Build your own container with your own specific dependencies using RUN commands.
  3. Use something like Docker Compose to mount your documentation source to /var/docs.
  4. Add your documentation-building task as an ENTRYPOINT.

docker-compose up the first time (or with --build) will build your custom container, then run your ENTRYPOINT task. Subsequent runs of docker-compose up will only execute your ENTRYPOINT task.

Sample Dockerfile

FROM skyzyx/alpine-pandoc:1.0.0

ENV PERSISTENT_DEPS wget git mercurial make gmp openssh
ENV SPHINXBUILD /usr/bin/sphinx-build
ENV SPHINXOPTS -T

# Copy Source code and set working directory
COPY src /var/docs
WORKDIR /var/docs

USER root

RUN apk add --no-cache --virtual .persistent-deps $PERSISTENT_DEPS && \
    pip install -r requirements.txt

ENTRYPOINT ["make", "docs"]

Sample docker-compose.yml

version: "3"
services:
    documentation-builder:
        build:
            context: .
            dockerfile: Dockerfile
        volumes:
            - ./src:/var/docs

Project Statistics

Sourcerank 3
Repository Size 4.88 KB
Stars 0
Forks 1
Watchers 1
Open issues 0
Dependencies 0
Contributors 1
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Ryan Parman

Something wrong with this page? Make a suggestion

Last synced: 2018-07-11 18:24:25 UTC

Login to resync this repository