Skip to content

Files

Latest commit

4bff812 · Mar 12, 2018

History

History
This branch is 367 commits behind GoogleCloudPlatform/runtimes-common:master.

docgen

About

docgen is a tool for generating Markdown documentation for container images.

How to install

This uses bazel as the build tool.

  • Clone this repo:
git clone https://github.com/GoogleCloudPlatform/runtimes-common.git
cd runtimes-common
  • Build:
bazel run //:gazelle
bazel build docgen/scripts/docgen:docgen
  • Set the path to the built scripts:
export PATH=$PATH:$PWD/bazel-bin/docgen/scripts
  • Example:
docgen --spec_file path/to/your/README.yaml > README.md

For an example of README.yaml and README.md files, see mysql-docker repo. The yaml data follows the structure defined in docgen.proto.