docbuild.constants

Constants for the CLI application.

Attributes

APP_NAME	The name of the application, used in paths and config files.
DEFAULT_LANGS	The default languages used by the application.
ALLOWED_LANGUAGES	The languages supported by the documentation portal.
SERVER_ROLES	The different server roles, including long and short spelling.
DEFAULT_LIFECYCLE	The default lifecycle state for a docset.
ALLOWED_LIFECYCLES	The available lifecycle states for a docset.
VALID_PRODUCTS	A dictionary of valid products acronyms and their full names.
ALLOWED_PRODUCTS	A tuple of valid product acronyms.
SINGLE_LANG_REGEX	Regex for a single language code in the format 'xx-XX' (e.g., 'en-us').
MULTIPLE_LANG_REGEX	Regex for multiple languages, separated by commas.
LIFECYCLES_STR	Regex for lifecycle states, separated by pipe (|).
SEPARATORS	Regex string for separators used in doctype strings.
RE_SEPARATORS	Compiled regex for separators used in doctype strings.
PROJECT_DIR	The current working directory, used as the project directory.
USER_CONFIG_DIR	The user-specific configuration directory, typically located
SYSTEM_CONFIG_DIR	The system-wide configuration directory, typically located
CONFIG_PATHS	The paths where the application will look for configuration files.
APP_CONFIG_BASENAMES	The base filenames for the application configuration files, in
PROJECT_LEVEL_APP_CONFIG_FILENAMES	Additional configuration filenames at the project level.
APP_CONFIG_FILENAME	The filename of the application's config file without any paths.
ENV_CONFIG_FILENAME	The filename of the environment's config file without any paths.
DEFAULT_ENV_CONFIG_FILENAME	The default filename for the environment's config file, typically
BASE_LOG_DIR	The directory where log files will be stored, typically at
XMLDATADIR	Directory where additional files (RNC, XSLT) for XML processing are stored.

Module Contents

docbuild.constants.APP_NAME = 'docbuild'

The name of the application, used in paths and config files.

docbuild.constants.DEFAULT_LANGS = ('en-us',)

The default languages used by the application.

docbuild.constants.ALLOWED_LANGUAGES

The languages supported by the documentation portal.

docbuild.constants.SERVER_ROLES

The different server roles, including long and short spelling.

docbuild.constants.DEFAULT_LIFECYCLE = 'supported'

The default lifecycle state for a docset.

docbuild.constants.ALLOWED_LIFECYCLES = ('supported', 'beta', 'hidden', 'unsupported')

The available lifecycle states for a docset.

docbuild.constants.VALID_PRODUCTS: dict[str, str]

A dictionary of valid products acronyms and their full names.

docbuild.constants.ALLOWED_PRODUCTS

A tuple of valid product acronyms.

docbuild.constants.SINGLE_LANG_REGEX

Regex for a single language code in the format ‘xx-XX’ (e.g., ‘en-us’).

docbuild.constants.MULTIPLE_LANG_REGEX

Regex for multiple languages, separated by commas.

docbuild.constants.LIFECYCLES_STR = ''

Regex for lifecycle states, separated by pipe (|).

docbuild.constants.SEPARATORS = '[ :;]+'

Regex string for separators used in doctype strings.

docbuild.constants.RE_SEPARATORS

Compiled regex for separators used in doctype strings.

docbuild.constants.PROJECT_DIR

The current working directory, used as the project directory.

docbuild.constants.USER_CONFIG_DIR

The user-specific configuration directory, typically located at ~/.config/docbuild.

docbuild.constants.SYSTEM_CONFIG_DIR

The system-wide configuration directory, typically located at /etc/docbuild.

docbuild.constants.CONFIG_PATHS

The paths where the application will look for configuration files.

docbuild.constants.APP_CONFIG_BASENAMES = ('.config.toml', 'config.toml')

The base filenames for the application configuration files, in order of priority.

docbuild.constants.PROJECT_LEVEL_APP_CONFIG_FILENAMES

Additional configuration filenames at the project level.

docbuild.constants.APP_CONFIG_FILENAME = 'config.toml'

The filename of the application’s config file without any paths.

docbuild.constants.ENV_CONFIG_FILENAME = 'env.{role}.toml'

The filename of the environment’s config file without any paths.

docbuild.constants.DEFAULT_ENV_CONFIG_FILENAME = 'env.production.toml'

The default filename for the environment’s config file, typically used in production.

docbuild.constants.BASE_LOG_DIR

The directory where log files will be stored, typically at ~/.local/state/docbuild/logs as recommended by the XDG Base Directory Specification.

docbuild.constants.XMLDATADIR

Directory where additional files (RNC, XSLT) for XML processing are stored.