universal_build.helpers.build_mkdocs.md

module universal_build.helpers.build_mkdocs

Utilities to help building MkDocs documentations.

---

function install_build_env

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 to True.

---

function lint_markdown

lint_markdown(markdownlint: bool = True, exit_on_error: bool = True) → None

Run markdownlint on markdown documentation.

Args:

• markdownlint (bool, optional): Activate markdown linting via markdownlint. Defaults to True.
• exit_on_error (bool, optional): Exit process if an error occurs. Defaults to True.

---

function build_mkdocs

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 to True.

---

function deploy_gh_pages

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 to True.

---

function run_dev_mode

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 to True.

---

This file was automatically generated via lazydocs.