mkdocs_demo.scripts ¶

scripts module.

gen_ref_pages ¶

This module generates reference pages for MkDocstrings.

_ = gen_ref_pages(config=RefGenConfig)

This module generates script entrypoints for Poetry related to MkDocs.

build = command_factory(
    cmd="mkdocs build --config-file src/mkdocs_demo/mkdocs.yml --clean --use-directory-urls"
)

serve = command_factory(
    cmd="mkdocs serve --config-file src/mkdocs_demo/mkdocs.yml"
)

This module generates script entrypoints for Poetry related to Mypy typings generation.

gen_types = command_factory(
    "stubgen -p mkdocs_demo -o typings"
)

This module generates script entrypoints for Poetry related to pre-commit.

install = command_factory(cmd='pre-commit install')

run = command_factory(cmd='pre-commit run --all-files')

update = command_factory(cmd='pre-commit autoupdate')