Skip to main content

Plugin for adding doc tree for terraform monorepos.

Project description


This introduces support for the !tf_modules_root syntax in mkdocs.yml, allowing you to import trees of README.md files for terraform modules directories that also contains a \*.tf file.
It enables large or complex repositories to have their own tree of modules folders, whilst generating only a single Mkdocs site.
This is built and maintained by the engineering community at Wunderman Thompson Commerce.
It was, however, inspired by and adapted from the Spotify backstage monorepo plugin.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file mkdocs-terraform-monorepo-plugin-0.1.3.tar.gz.

File metadata

  • Download URL: mkdocs-terraform-monorepo-plugin-0.1.3.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for mkdocs-terraform-monorepo-plugin-0.1.3.tar.gz
Algorithm Hash digest
SHA256 cf0c30fcf89df9acbe99ced5e5ff041a53e495330c7a525dc312340ad2021ff6
MD5 16169ac9c2b9f515345d42bc445b3d87
BLAKE2b-256 91a774faeb59025904fbd5f0d32ea41ee7eb548a733f2df402f0ec17f6f82829

See more details on using hashes here.

File details

Details for the file mkdocs_terraform_monorepo_plugin-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_terraform_monorepo_plugin-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for mkdocs_terraform_monorepo_plugin-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5d24af0d896da983479cf608c8a63c07d09b8516a2cc140dabb947024f042fb6
MD5 004d8b4ac02fcac160a4ac2b46237ddd
BLAKE2b-256 a8f81fe98ff8b15965446022cec85eb8a489f4c8437eb50abd1f3942df5eb467

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page