Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

cookiecutter-autodocs documentation

Toggle table of contents sidebar

cookiecutter-autodocs documentation

Quick Start
Development
Generated Module Documentation
Toggle child pages in navigation
- cookiecutter_autodocs
  Toggle child pages in navigation
  - cookiecutter_autodocs.cli
    Toggle child pages in navigation
    - cookiecutter_autodocs.cli.main
    - cookiecutter_autodocs.cli.app
    - cookiecutter_autodocs.cli.generate
      Toggle child pages in navigation
    - cookiecutter_autodocs.cli.gha
      Toggle child pages in navigation
      - cookiecutter_autodocs.cli.gha.gha
      - cookiecutter_autodocs.cli.gha.GHAAction
    - cookiecutter_autodocs.cli.validate
      Toggle child pages in navigation
      - cookiecutter_autodocs.cli.validate.validate
  - cookiecutter_autodocs.lib
    Toggle child pages in navigation
    - cookiecutter_autodocs.lib.files
      Toggle child pages in navigation
    - cookiecutter_autodocs.lib.typing
  - cookiecutter_autodocs.schemas
    Toggle child pages in navigation
    - cookiecutter_autodocs.schemas.description
      Toggle child pages in navigation
      - cookiecutter_autodocs.schemas.description.CookieCutterDescription
      - cookiecutter_autodocs.schemas.description.VariableDescription
CLI Documentation

Toggle table of contents sidebar

Quick Start#

Examples#

Installation#

Install the package

pip install cookiecutter-autodocs

Quick Usage#

Copyright © 2023, Andrew Herrington

Made with Sphinx and @pradyunsg's Furo

On this page

Quick Start