mafw.devtools.documentation.builder

Sphinx documentation building helpers for MAFw versioned documentation.

This module provides functions for building Sphinx documentation across multiple git tags, managing git worktrees, and handling documentation zip archives.

Module Attributes

DEFAULT_MIN_TAG_REGEX	Regular expression to match stable version tags.
DOCS_SUBPATH	The files/directories under each worktree where docs live.
SPHINX_BUILD_CMD	Sphinx build command name.
OLD_VERSION_TO_BE_PATCHED	Tags that require patching with the latest conf.py.

mafw.devtools.documentation.builder.DEFAULT_MIN_TAG_REGEX = '^v([1-9][0-9]*)\\.[0-9]+\\.[0-9]+(\\.[0-9]+)?$'

Regular expression to match stable version tags.

mafw.devtools.documentation.builder.DOCS_SUBPATH = PosixPath('docs/source')

The files/directories under each worktree where docs live.

mafw.devtools.documentation.builder.OLD_VERSION_TO_BE_PATCHED = ['v1.0.0', 'v1.1.0', 'v1.2.0', 'v1.3.0', 'v1.4.0']

Tags that require patching with the latest conf.py.

mafw.devtools.documentation.builder.SPHINX_BUILD_CMD = 'sphinx-build'

Sphinx build command name.