NAME

repomatic update-docs - Regenerate Sphinx API docs and dynamic content

SYNOPSIS

repomatic update-docs [OPTIONS]

DESCRIPTION

Regenerate Sphinx autodoc stubs and run the project's update script.

Orchestrates four phases:

1. Run `sphinx-apidoc` to generate RST stubs for all modules. 2. If MyST-Parser is detected, convert the RST stubs to MyST markdown with {eval-rst} blocks. 3. Run the project-specific `docs/docs_update.py` script (if present) to generate dynamic content. 4. Refresh self-updating blocks ({matrix} compatibility tables and `python:render` `:mirror:` regions) found in `docs/` pages and `readme.md`, via `click-extra refresh-directives`.

With --check, phases 1-2 are skipped and phases 3-4 run in their own check modes to report drift without writing (the update script must accept a --check flag to participate).

Configuration is read from `[tool.repomatic]` in `pyproject.toml`.

OPTIONS

--check

Report out-of-date self-updating content and exit non-zero, without writing anything. For CI drift detection.

--help / -h

Show this message and exit.

ENVIRONMENT

UPDATE_DOCS_CHECK

Report out-of-date self-updating content and exit non-zero, without writing anything. For CI drift detection.

UPDATE_DOCS__CLICK_DEFAULT_HELP

Show this message and exit.

EXIT STATUS

0

Success.

1

A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).

2

A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

AUTHORS

Kevin Deldycke