odoo-docs-scaffolder
Streamlines creation of new Odoo documentation pages using standard templates. Use when starting a new documentation page, tutorial, or API reference to ensure correct initial structure, metadata, and media folder organization.
When & Why to Use This Skill
The Odoo Documentation Scaffolder is a specialized productivity tool designed to automate the creation of standardized Odoo documentation pages. By leveraging pre-defined RST templates and automated directory management, it ensures that all new tutorials, API references, and application guides maintain consistent metadata, structure, and media organization, significantly reducing the manual overhead for technical writers and developers.
Use Cases
- New Feature Documentation: Rapidly scaffold standard application pages with pre-configured metadata and dedicated media folders to maintain project organization.
- Developer Tutorial Creation: Utilize structured templates to build step-by-step technical guides that follow Odoo's educational standards.
- API Reference Generation: Streamline the documentation of technical code and models using specialized templates designed for API clarity.
- Documentation Consistency Audits: Ensure all new contributions adhere to the required organizational hierarchy and metadata tags (like :show-content:) automatically.
| name | odoo-docs-scaffolder |
|---|---|
| description | Streamlines creation of new Odoo documentation pages using standard templates. Use when starting a new documentation page, tutorial, or API reference to ensure correct initial structure, metadata, and media folder organization. |
Odoo Documentation Scaffolder
Quickly generate new documentation pages with standardized structure and associated media folders.
Quick Start
Scaffold a New Page
Run the scaffolding script with the target path and optional template name.
# Create a standard application page
python3 scripts/scaffold.py content/applications/sales/my_new_feature.rst
# Create a developer tutorial
python3 scripts/scaffold.py content/developer/tutorials/my_tutorial.rst tutorial.rst
# Create an API reference
python3 scripts/scaffold.py content/developer/reference/my_api.rst api_reference.rst
The script will:
- Copy the template to the target path.
- Create a media folder with the same name as the RST file (e.g.,
content/applications/sales/my_new_feature/). - Ensure correct metadata (like
:show-content:) is included.
Available Templates
standard_page.rst: Default template for general documentation.tutorial.rst: Structured for step-by-step learning.api_reference.rst: Template for documenting technical code and models.
Resources
scripts/
scaffold.py: Main utility for creating pages and folders.
assets/templates/
- Collection of
.rstboilerplates.