Index Symbols | _ | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | X | Z Symbols --app-config docbuild command line option --debug docbuild command line option --dry-run docbuild command line option --env-config docbuild command line option --no-debug docbuild command line option --verbose docbuild command line option --version docbuild command line option -v docbuild command line option _ __aenter__() (docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory method) __aexit__() (docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory method) __bool__() (docbuild.config.xml.checks.CheckResult method) __call__() (docbuild.utils.decorators.RegistryDecorator method) __contains__() (docbuild.models.doctype.Doctype method) (docbuild.models.lifecycle.BaseLifecycleFlag method) (docbuild.models.repo.Repo method) __enter__() (docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory method) __eq__() (docbuild.models.doctype.Doctype method) (docbuild.models.language.LanguageCode method) (docbuild.models.repo.Repo method) __exit__() (docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory method) __getitem__() (docbuild.models.product.StrEnumMeta method) __hash__() (docbuild.models.deliverable.Deliverable method) (docbuild.models.doctype.Doctype method) (docbuild.models.language.LanguageCode method) (docbuild.models.repo.Repo method) __lt__() (docbuild.models.doctype.Doctype method) (docbuild.models.language.LanguageCode method) __repr__() (docbuild.models.deliverable.Deliverable method) (docbuild.models.doctype.Doctype method) (docbuild.models.language.LanguageCode method) __str__() (docbuild.models.doctype.Doctype method) (docbuild.models.language.LanguageCode method) (docbuild.models.repo.Repo method) A acronym (docbuild.models.deliverable.Deliverable property) ADoc ALLOWED_LANGS (docbuild.models.language.LanguageCode attribute) ALLOWED_LANGUAGES (in module docbuild.constants) ALLOWED_LIFECYCLES (in module docbuild.constants) ALLOWED_PRODUCTS (in module docbuild.constants) app() (in module docbuild.cli.cmd_config.application) APP_CONFIG_BASENAMES (in module docbuild.constants) APP_CONFIG_FILENAME (in module docbuild.constants) APP_NAME (in module docbuild.constants) appconfig (docbuild.cli.context.DocBuildContext attribute) appconfig_from_defaults (docbuild.cli.context.DocBuildContext attribute) appconfigfiles (docbuild.cli.context.DocBuildContext attribute) Argument ASCIIDoc Asynchronous Programming asyncio B BASE_LOG_DIR (in module docbuild.constants) basefile (docbuild.models.deliverable.Deliverable property) branch (docbuild.models.deliverable.Deliverable property) build() (in module docbuild.cli.cmd_build) C c14n() (in module docbuild.cli.cmd_c14n) calc_max_len() (in module docbuild.utils.paths) Changelog check_dc_in_language() (in module docbuild.config.xml.checks) check_duplicated_categoryid() (in module docbuild.config.xml.checks) check_duplicated_format_in_extralinks() (in module docbuild.config.xml.checks) check_duplicated_linkid() (in module docbuild.config.xml.checks) check_duplicated_url_in_extralinks() (in module docbuild.config.xml.checks) check_enabled_format() (in module docbuild.config.xml.checks) check_format_subdeliverable() (in module docbuild.config.xml.checks) check_lang_code_in_category() (in module docbuild.config.xml.checks) check_lang_code_in_desc() (in module docbuild.config.xml.checks) check_lang_code_in_docset() (in module docbuild.config.xml.checks) check_lang_code_in_extralinks() (in module docbuild.config.xml.checks) check_lang_code_in_overridedesc() (in module docbuild.config.xml.checks) check_ref_to_deliverable() (in module docbuild.config.xml.references) check_ref_to_docset() (in module docbuild.config.xml.references) check_ref_to_link() (in module docbuild.config.xml.references) check_ref_to_product() (in module docbuild.config.xml.references) check_ref_to_subdeliverable() (in module docbuild.config.xml.references) check_stitched_references() (in module docbuild.config.xml.references) check_stitchfile() (in module docbuild.config.xml.stitch) check_subdeliverable_in_deliverable() (in module docbuild.config.xml.checks) check_translation_deliverables() (in module docbuild.config.xml.checks) check_valid_languages() (in module docbuild.config.xml.checks) CI/CD cli() (in module docbuild.cli.cmd_cli) clone() (in module docbuild.cli.cmd_repo.cmd_clone) clone_repo() (in module docbuild.cli.cmd_repo.process) cmd_dir() (in module docbuild.cli.cmd_repo.cmd_dir) cmd_list() (in module docbuild.cli.cmd_repo.cmd_list) coerce_docset() (docbuild.models.doctype.Doctype class method) coerce_langs() (docbuild.models.doctype.Doctype class method) coerce_lifecycle() (docbuild.models.doctype.Doctype class method) coerce_product() (docbuild.models.doctype.Doctype class method) Concurrency config() (in module docbuild.cli.cmd_config) CONFIG_PATHS (in module docbuild.constants) convert2bool() (in module docbuild.utils.convert) country() (docbuild.models.language.LanguageCode method) create_base_log_dir() (in module docbuild.logging) create_stitchfile() (in module docbuild.config.xml.stitch) D DAPS dateModified (docbuild.models.metadata.Metadata attribute) DC File dcfile (docbuild.models.deliverable.Deliverable property) debug (docbuild.cli.context.DocBuildContext attribute) deep_merge() (in module docbuild.config.merge) DEFAULT_APP_CONFIG (in module docbuild.cli.defaults) DEFAULT_DELIVERABLES (in module docbuild.constants) DEFAULT_ENV_CONFIG (in module docbuild.cli.defaults) DEFAULT_ENV_CONFIG_FILENAME (in module docbuild.constants) DEFAULT_HOST (docbuild.models.repo.Repo attribute) DEFAULT_LANGS (in module docbuild.constants) DEFAULT_LIFECYCLE (in module docbuild.constants) Deliverable display_results() (in module docbuild.cli.cmd_validate.process) DocBook docbuild module docbuild command line option --app-config --debug --dry-run --env-config --no-debug --verbose --version -v docbuild-build command line option DOCTYPES docbuild-metadata command line option DOCTYPES docbuild-repo-clone command line option REPOS docbuild-validate command line option XMLFILES docbuild.__about__ module docbuild.__main__ module docbuild.cli module docbuild.cli.cmd_build module docbuild.cli.cmd_c14n module docbuild.cli.cmd_cli module docbuild.cli.cmd_config module docbuild.cli.cmd_config.application module docbuild.cli.cmd_config.environment module docbuild.cli.cmd_metadata module docbuild.cli.cmd_metadata.metaprocess module docbuild.cli.cmd_repo module docbuild.cli.cmd_repo.cmd_clone module docbuild.cli.cmd_repo.cmd_dir module docbuild.cli.cmd_repo.cmd_list module docbuild.cli.cmd_repo.process module docbuild.cli.cmd_validate module docbuild.cli.cmd_validate.process module docbuild.cli.context module docbuild.cli.context.DocBuildContext (built-in class) docbuild.cli.defaults module docbuild.config module docbuild.config.app module docbuild.config.app.CircularReferenceError docbuild.config.app.PlaceholderResolutionError docbuild.config.app.PlaceholderResolver (built-in class) docbuild.config.load module docbuild.config.merge module docbuild.config.xml module docbuild.config.xml.checks module docbuild.config.xml.checks.CheckResult (built-in class) docbuild.config.xml.list module docbuild.config.xml.references module docbuild.config.xml.stitch module docbuild.constants module docbuild.logging module docbuild.models module docbuild.models.deliverable module docbuild.models.deliverable.Deliverable (built-in class) docbuild.models.doctype module docbuild.models.doctype.Doctype (built-in class) docbuild.models.language module docbuild.models.language.LanguageCode (built-in class) docbuild.models.lifecycle module docbuild.models.lifecycle.BaseLifecycleFlag (built-in class) docbuild.models.metadata module docbuild.models.metadata.Metadata (built-in class) docbuild.models.product module docbuild.models.product.BaseProductEnum (built-in class) docbuild.models.product.StrEnumMeta (built-in class) docbuild.models.repo module docbuild.models.repo.Repo (built-in class) docbuild.models.serverroles module docbuild.models.serverroles.ServerRole (built-in class) docbuild.utils module docbuild.utils.contextmgr module docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory (built-in class) docbuild.utils.contextmgr.TimerData (built-in class) docbuild.utils.convert module docbuild.utils.decorators module docbuild.utils.decorators.RegistryDecorator (built-in class) docbuild.utils.merge module docbuild.utils.paths module Docset docset (docbuild.models.doctype.Doctype attribute) docset_node (docbuild.models.deliverable.Deliverable property) docsetid (docbuild.models.deliverable.Deliverable property) docsuite (docbuild.models.deliverable.Deliverable property) Doctype DOCTYPES docbuild-build command line option docbuild-metadata command line option doctypes (docbuild.cli.context.DocBuildContext attribute) dry_run (docbuild.cli.context.DocBuildContext attribute) E env() (in module docbuild.cli.cmd_config.environment) ENV_CONFIG_FILENAME (in module docbuild.constants) envconfig (docbuild.cli.context.DocBuildContext attribute) envconfig_from_defaults (docbuild.cli.context.DocBuildContext attribute) envconfigfiles (docbuild.cli.context.DocBuildContext attribute) environment variable PATH F F (in module docbuild.utils.decorators) factory_registry() (in module docbuild.utils.decorators) format (docbuild.models.deliverable.Deliverable property) from_str() (docbuild.models.doctype.Doctype class method) (docbuild.models.lifecycle.BaseLifecycleFlag class method) full_id (docbuild.models.deliverable.Deliverable property) G get_deliverable_from_doctype() (in module docbuild.cli.cmd_metadata.metaprocess) get_effective_level() (in module docbuild.logging) GIL git (docbuild.models.deliverable.Deliverable property) GitHub Action Global Interpreter Lock H handle_config() (in module docbuild.config.load) html_path (docbuild.models.deliverable.Deliverable property) I IPython K KEEP_LOGS (in module docbuild.logging) L lang (docbuild.models.deliverable.Deliverable property) lang() (docbuild.models.language.LanguageCode method) lang_is_default (docbuild.models.deliverable.Deliverable property) langs (docbuild.models.doctype.Doctype attribute) language (docbuild.models.deliverable.Deliverable property) (docbuild.models.language.LanguageCode attribute) Lifecycle lifecycle (docbuild.models.deliverable.Deliverable property) (docbuild.models.doctype.Doctype attribute) LifecycleFlag (in module docbuild.models.lifecycle) LIFECYCLES_STR (in module docbuild.constants) list_all_deliverables() (in module docbuild.config.xml.list) load_and_merge_configs() (in module docbuild.config.load) load_check_functions() (in module docbuild.config.xml.stitch) load_single_config() (in module docbuild.config.load) LOGFILE (in module docbuild.logging) LOGGERNAME (in module docbuild.logging) M make_safe_name() (docbuild.models.deliverable.Deliverable static method) make_timer() (in module docbuild.utils.contextmgr) matches() (docbuild.models.language.LanguageCode method) MAX_RECURSION_DEPTH (in module docbuild.config.app) merge_doctypes() (in module docbuild.utils.merge) meta (docbuild.models.deliverable.Deliverable property) metadata() (in module docbuild.cli.cmd_metadata) metafile (docbuild.models.deliverable.Deliverable property) model_config (docbuild.models.language.LanguageCode attribute) Module module docbuild docbuild.__about__ docbuild.__main__ docbuild.cli docbuild.cli.cmd_build docbuild.cli.cmd_c14n docbuild.cli.cmd_cli docbuild.cli.cmd_config docbuild.cli.cmd_config.application docbuild.cli.cmd_config.environment docbuild.cli.cmd_metadata docbuild.cli.cmd_metadata.metaprocess docbuild.cli.cmd_repo docbuild.cli.cmd_repo.cmd_clone docbuild.cli.cmd_repo.cmd_dir docbuild.cli.cmd_repo.cmd_list docbuild.cli.cmd_repo.process docbuild.cli.cmd_validate docbuild.cli.cmd_validate.process docbuild.cli.context docbuild.cli.defaults docbuild.config docbuild.config.app docbuild.config.load docbuild.config.merge docbuild.config.xml docbuild.config.xml.checks docbuild.config.xml.list docbuild.config.xml.references docbuild.config.xml.stitch docbuild.constants docbuild.logging docbuild.models docbuild.models.deliverable docbuild.models.doctype docbuild.models.language docbuild.models.lifecycle docbuild.models.metadata docbuild.models.product docbuild.models.repo docbuild.models.serverroles docbuild.utils docbuild.utils.contextmgr docbuild.utils.convert docbuild.utils.decorators docbuild.utils.merge docbuild.utils.paths MULTIPLE_LANG_REGEX (in module docbuild.constants) Mutex N name (docbuild.models.repo.Repo attribute) node (docbuild.models.deliverable.Deliverable property) O Option P Package Parallelism PATH pdf_path (docbuild.models.deliverable.Deliverable property) pdlang (docbuild.models.deliverable.Deliverable property) pdlangdc (docbuild.models.deliverable.Deliverable property) PEP PLACEHOLDER_PATTERN (docbuild.config.app.PlaceholderResolver attribute) process() (in module docbuild.cli.cmd_metadata.metaprocess) (in module docbuild.cli.cmd_repo.process) (in module docbuild.cli.cmd_validate.process) process_deliverable() (in module docbuild.cli.cmd_metadata.metaprocess) process_doctype() (in module docbuild.cli.cmd_metadata.metaprocess) process_envconfig() (in module docbuild.config.load) process_file() (in module docbuild.cli.cmd_validate.process) Product product (docbuild.models.doctype.Doctype attribute) Product (in module docbuild.models.product) product_docset (docbuild.models.deliverable.Deliverable property) product_node (docbuild.models.deliverable.Deliverable property) productid (docbuild.models.deliverable.Deliverable property) PRODUCTION (docbuild.models.serverroles.ServerRole attribute) productname (docbuild.models.deliverable.Deliverable property) products (docbuild.models.metadata.Metadata attribute) PROJECT_DIR (in module docbuild.constants) PROJECT_LEVEL_APP_CONFIG_FILENAMES (in module docbuild.constants) pyproject.toml Pytest Python Enhancement Proposals PEP 518 PEP 621 R RE_SEPARATORS (in module docbuild.constants) read() (docbuild.models.metadata.Metadata method) relpath (docbuild.models.deliverable.Deliverable property) replace() (docbuild.config.app.PlaceholderResolver method) replace_placeholders() (in module docbuild.config.app) repo() (in module docbuild.cli.cmd_repo) repo_path (docbuild.models.deliverable.Deliverable property) REPOS docbuild-repo-clone command line option rootid (docbuild.models.metadata.Metadata attribute) Ruff run_command() (in module docbuild.cli.cmd_validate.process) run_python_checks() (in module docbuild.cli.cmd_validate.process) S Semantic Versioning SemVer seo_description (docbuild.models.metadata.Metadata attribute) seo_social_descr (docbuild.models.metadata.Metadata attribute) seo_title (docbuild.models.metadata.Metadata attribute) SEPARATORS (in module docbuild.constants) series (docbuild.models.metadata.Metadata attribute) SERVER_ROLES (in module docbuild.constants) setup_logging() (in module docbuild.logging) SINGLE_LANG_REGEX (in module docbuild.constants) singlehtml_path (docbuild.models.deliverable.Deliverable property) slug (docbuild.models.repo.Repo property) Sphinx STAGING (docbuild.models.serverroles.ServerRole attribute) subdir (docbuild.models.deliverable.Deliverable property) subtitle (docbuild.models.metadata.Metadata attribute) surl (docbuild.models.repo.Repo attribute) SYSTEM_CONFIG_DIR (in module docbuild.constants) T tasks (docbuild.models.metadata.Metadata attribute) TESTING (docbuild.models.serverroles.ServerRole attribute) title (docbuild.models.metadata.Metadata attribute) to_dict() (docbuild.models.deliverable.Deliverable method) TOML U url (docbuild.models.repo.Repo attribute) USER_CONFIG_DIR (in module docbuild.constants) UV V VALID_PRODUCTS (in module docbuild.constants) validate() (in module docbuild.cli.cmd_validate) validate_language() (docbuild.models.language.LanguageCode class method) validate_rng() (in module docbuild.cli.cmd_validate.process) VENV verbose (docbuild.cli.context.DocBuildContext attribute) version (docbuild.models.deliverable.Deliverable property) Virtual Python Environment X XML XMLDATADIR (in module docbuild.constants) XMLFILES docbuild-validate command line option xpath() (docbuild.models.doctype.Doctype method) XSLT Z zip_path (docbuild.models.deliverable.Deliverable property)
