autodoc

Overview ¶

Package autodoc contains the engine for the autodoc command line application to automatically generate mkdocs-style documentation for the provider. This application uses text templates and feeds them the parsed schema data to produce up-to-date documentation.

This application takes the following arguments:

-provider=NAME
  Name of the Terraform provider. Defaults to "Terraform Provider".
-root
  The root directory to being placing output documentation files. Defaults
  to the current working directory. The mkdocs.yml file will be placed
  in this location.
-docs-dir
  The name of the directory to place generated documentation. This will
  be placed under the parameter supplied for -root. Defaults to 'docs'.
  The autogenerated mkdocs.yml file will have its 'docs_dir' set to this
  value.
-templates-dir
  The directory to search for template files. Templates are searched
  and loaded recursively from this directory. Defaults to
  '$(cwd)/templates'
-template-ext
  File extension for template files. Defaults to '.template'

Arguments can be assigned values by using the '=' operator:

$> autodoc -root='/my/path'

This application will exit 1 on error, 0 on success.

The following files are generated as output by the application. Let $(cwd) be the value supplied to -root, and $(docs) be the value supplied to -docs-dir:

1. $(cwd)/mkdocs.yml mkdocs configuration file
2. $(cwd)/$(docs)/index.md provider documentation file
3. $(cwd)/$(docs)/resources/*.md All resource documentation. There will be one md file for each resource. The resource files will be named corresponding to its name in the provider's ResourcesMap.
4. $(cwd)/$(docs)/data-sources/*.md All datasource documentation. There will be one md file for each datasource. The datasource files will be named corresponding to its name in the provider's DataSourcesMap.

This application assumes the user has read/write access to all output paths

This application uses the following template associations for each output file:

mkdocs.yml.template
  $(cwd)/mkdocs.yml => mkdocs configuration
index.md.template
  $(cwd)/$(docs)/index.md => Provider documentation
resource.md.template
  $(cwd)/$(docs)/resources/*.md => Documentation for all resources
datasource.md.template
  $(cwd)/$(docs)/data-sources/*.md => Documentation for all data sources