Utilities to help building MkDocs documentations.
install_build_env(exit_on_error: bool = True) → None
Installs a new virtual environment via pipenv.
Args:
exit_on_error
(bool, optional): Exit process if an error occurs. Defaults toTrue
.
lint_markdown(markdownlint: bool = True, exit_on_error: bool = True) → None
Run markdownlint on markdown documentation.
Args:
markdownlint
(bool, optional): Activate markdown linting viamarkdownlint
. Defaults toTrue
.exit_on_error
(bool, optional): Exit process if an error occurs. Defaults toTrue
.
build_mkdocs(exit_on_error: bool = True) → None
Build mkdocs markdown documentation.
Args:
exit_on_error
(bool, optional): Exit process if an error occurs. Defaults toTrue
.
deploy_gh_pages(exit_on_error: bool = True) → None
Deploy mkdocs documentation to Github pages.
Args:
exit_on_error
(bool, optional): Exit process if an error occurs. Defaults toTrue
.
run_dev_mode(port: int = 8001, exit_on_error: bool = True) → None
Run mkdocs development server.
Args:
port
(int, optional): Port to use for mkdocs development server. Defaults to 8001.exit_on_error
(bool, optional): Exit process if an error occurs. Defaults toTrue
.
This file was automatically generated via lazydocs.