🍽️📖 plating¶
Documentation generation system for Terraform/OpenTofu providers.
🤖 AI-Generated Content
This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.
Overview¶
plating is a documentation generation tool designed specifically for Terraform and OpenTofu providers. It automates the creation of provider documentation, including resource and data source references, from provider code and schemas.
This tool helps maintain consistent, accurate documentation for providers by generating it directly from the provider implementation.
Key Capabilities¶
- Automated Documentation: Generate documentation from provider schemas and code
- Terraform/OpenTofu Focus: Specialized templates for provider documentation
- Resource Documentation: Automatic generation of resource and data source reference docs
- Schema Documentation: Document provider configuration schemas
- Markdown Output: Generate standard Markdown documentation files
- Template System: Customizable templates for documentation structure
Installation¶
Documentation¶
For usage guides, template reference, and customization options, see the Plating documentation.
Repository¶
- Repository: plating
- Package:
platingon PyPI - License: Apache-2.0