Procedurally generated documentation
Branch: master
Clone or download
Pull request Compare This branch is 67 commits ahead of IronicBadger:master.
Latest commit d523ae6 Feb 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
readme forked and moved to LSIO Aug 1, 2018
roles/generate-docs fix compose grouping of variables Feb 8, 2019
vars add cap-add to sample Feb 8, 2019
.dockerignore now builds in a docker container with runtime env var Jul 30, 2018
Dockerfile removed volume declaration that wasnt needed Jul 31, 2018
README.md
generate.yml need to set the github branch before the run to pull the correct vari… Dec 3, 2018

README.md

linuxserver/doc-builder

Expects to run as part of the LSIO CI process. Not for public consumption.

**Running against remote: **

docker run --rm \
 -e CONTAINER_NAME=${CONTAINER_NAME} \
 -v ${TEMPDIR}:/ansible/readme \
 linuxserver/doc-builder:latest

**Running locally: **

If you need to test functionality just navigate to the folder with the readme-vars.yml and run:

docker run --rm \
 -v $(pwd):/tmp \
 -e LOCAL=true \
 linuxserver/doc-builder:latest

The output will be in a GENERATED.md in your current working directory.