Index

Symbols

--allow-empty-description cookiecutter-autodoc-validate command line option --install-completion cookiecutter-autodoc command line option --no-allow-empty-description cookiecutter-autodoc-validate command line option --outfile cookiecutter-autodoc-generate-markdown command line option --output cookiecutter-autodoc-generate-cookiecutter command line option cookiecutter-autodoc-generate-desc command line option

--show-completion cookiecutter-autodoc command line option --template cookiecutter-autodoc-generate-markdown command line option -o cookiecutter-autodoc-generate-cookiecutter command line option cookiecutter-autodoc-generate-desc command line option cookiecutter-autodoc-generate-markdown command line option -t cookiecutter-autodoc-generate-markdown command line option

_

__init__() (cookiecutter_autodocs.cli.gha.GHAAction method) (cookiecutter_autodocs.schemas.description.CookieCutterDescription method) (cookiecutter_autodocs.schemas.description.VariableDescription method)

C

construct() (cookiecutter_autodocs.schemas.description.CookieCutterDescription class method) (cookiecutter_autodocs.schemas.description.VariableDescription class method) cookiecutter() (in module cookiecutter_autodocs.cli.generate) cookiecutter-autodoc command line option --install-completion --show-completion cookiecutter-autodoc-generate-cookiecutter command line option --output -o COOKIECUTTER_DESC cookiecutter-autodoc-generate-desc command line option --output -o COOKIECUTTER_JSON cookiecutter-autodoc-generate-markdown command line option --outfile --template -o -t COOKIECUTTER_DESC cookiecutter-autodoc-validate command line option --allow-empty-description --no-allow-empty-description COOKIECUTTER_DESC COOKIECUTTER_JSON cookiecutter_autodocs module cookiecutter_autodocs.cli module

cookiecutter_autodocs.cli.app module cookiecutter_autodocs.cli.generate module cookiecutter_autodocs.cli.gha module cookiecutter_autodocs.cli.validate module cookiecutter_autodocs.lib module cookiecutter_autodocs.lib.files module cookiecutter_autodocs.lib.typing module cookiecutter_autodocs.schemas module cookiecutter_autodocs.schemas.description module COOKIECUTTER_DESC cookiecutter-autodoc-generate-cookiecutter command line option cookiecutter-autodoc-generate-markdown command line option cookiecutter-autodoc-validate command line option cookiecutter_desc_dict (cookiecutter_autodocs.schemas.description.CookieCutterDescription property) COOKIECUTTER_JSON cookiecutter-autodoc-generate-desc command line option cookiecutter-autodoc-validate command line option cookiecutter_json (cookiecutter_autodocs.schemas.description.CookieCutterDescription property) CookieCutterDescription (class in cookiecutter_autodocs.schemas.description) copy() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method) (cookiecutter_autodocs.schemas.description.VariableDescription method)

D

desc() (in module cookiecutter_autodocs.cli.generate) dict() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method) (cookiecutter_autodocs.schemas.description.VariableDescription method)

doc() (in module cookiecutter_autodocs.cli.generate) dump_cookiecutter_description() (in module cookiecutter_autodocs.lib.files) dump_cookiecutter_json() (in module cookiecutter_autodocs.lib.files)

F

from_cookiecutter_desc() (cookiecutter_autodocs.schemas.description.CookieCutterDescription class method)

from_cookiecutter_json() (cookiecutter_autodocs.schemas.description.CookieCutterDescription class method)

G

gha() (in module cookiecutter_autodocs.cli.gha)

GHAAction (class in cookiecutter_autodocs.cli.gha)

J

json() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method) (cookiecutter_autodocs.schemas.description.VariableDescription method)

L

load_cookiecutter_description() (in module cookiecutter_autodocs.lib.files)

load_cookiecutter_json() (in module cookiecutter_autodocs.lib.files)

M

main() (in module cookiecutter_autodocs.cli) markdown() (in module cookiecutter_autodocs.cli.generate) module cookiecutter_autodocs cookiecutter_autodocs.cli cookiecutter_autodocs.cli.app cookiecutter_autodocs.cli.generate cookiecutter_autodocs.cli.gha cookiecutter_autodocs.cli.validate cookiecutter_autodocs.lib cookiecutter_autodocs.lib.files cookiecutter_autodocs.lib.typing cookiecutter_autodocs.schemas cookiecutter_autodocs.schemas.description

S

set_required() (cookiecutter_autodocs.schemas.description.VariableDescription class method)

set_type() (cookiecutter_autodocs.schemas.description.VariableDescription class method)

T

to_cookiecutter_desc() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method)

to_cookiecutter_json() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method)

U

update() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method)

update_forward_refs() (cookiecutter_autodocs.schemas.description.CookieCutterDescription class method) (cookiecutter_autodocs.schemas.description.VariableDescription class method)

V

validate() (in module cookiecutter_autodocs.cli.validate) validate_cookiecutter_json() (cookiecutter_autodocs.schemas.description.CookieCutterDescription method)

VariableDescription (class in cookiecutter_autodocs.schemas.description) VariableDescription.Config (class in cookiecutter_autodocs.schemas.description)