click-extra refresh-directives - Refresh the self-updating
directive blocks embedded in Markdown files.
click-extra refresh-directives [OPTIONS]
PATHS...
Refresh the self-updating directive blocks embedded in Markdown
files.
Walks each PATH (a Markdown file, or a directory scanned
recursively for Markdown sources) and regenerates the content of every
supported self-updating directive from its own options, rewriting the block
in place. Only blocks that already exist are refreshed: nothing is added or
removed.
Pass --check to report stale blocks without writing; the command
then exits with a non-zero status, so a continuous-integration job can fail
on out-of-date documentation.
Refreshing reads the project git history and needs the sphinx
extra: install it with click-extra[sphinx].
- PATHS...
- --check
- Do not write; exit with a non-zero status if any block is stale.
- --time /
--no-time
- Measure and print elapsed execution time.
- --config
CONFIG_PATH
- Location of the configuration file. Supports local path with glob patterns
or remote URL.
- --no-config
- Ignore all configuration files and only use command line parameters and
environment variables.
- --validate-config
FILE
- Validate the configuration file and exit.
- --export-config
FORMAT
- Export the configuration in the selected format to <stdout>, then
exit.
- --accessible
- Accessibility mode: disable colors and render tables in a plain,
screen-reader-friendly format.
- --color[=auto|always|never]
- Colorize the output. A bare --color is the same as --color=always.
- --no-color
- Disable colorization (alias of --color=never).
- --progress /
--no-progress
- Show progress indicators during long operations. Disabled for
non-interactive output (pipes, dumb terminals, CI) and by
--accessible.
- --theme
[dark|dracula|light|manpage|monokai|nord|solarized_dark]
- Color theme used for help screens.
- --show-params
- Show all CLI parameters, their provenance, defaults and value, then
exit.
- --table-format
[aligned|asciidoc|colon-grid|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|hjson|html|jira|json|json5|jsonc|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|toml|tsv|unsafehtml|vertical|xml|yaml|youtrack]
- Rendering style of tables.
- --verbosity
LEVEL
- Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
- --verbose /
-v
- --quiet /
-q
- --man
- Show the command's man page (roff) and exit.
- --version
- Show the version and exit.
- -h / --help
- Show this message and exit.
- REFRESH_DIRECTIVES_CHECK
- Do not write; exit with a non-zero status if any block is stale.
- REFRESH_DIRECTIVES_TIME
- Measure and print elapsed execution time.
- REFRESH_DIRECTIVES_CONFIG
- Location of the configuration file. Supports local path with glob patterns
or remote URL.
- REFRESH_DIRECTIVES_VALIDATE_CONFIG
- Validate the configuration file and exit.
- REFRESH_DIRECTIVES_EXPORT_CONFIG
- Export the configuration in the selected format to <stdout>, then
exit.
- REFRESH_DIRECTIVES_ACCESSIBLE
- Accessibility mode: disable colors and render tables in a plain,
screen-reader-friendly format.
- REFRESH_DIRECTIVES_COLOR
- Colorize the output. A bare --color is the same as --color=always.
- REFRESH_DIRECTIVES_NO_COLOR
- Disable colorization (alias of --color=never).
- REFRESH_DIRECTIVES_PROGRESS
- Show progress indicators during long operations. Disabled for
non-interactive output (pipes, dumb terminals, CI) and by
--accessible.
- REFRESH_DIRECTIVES_THEME
- Color theme used for help screens.
- REFRESH_DIRECTIVES_SHOW_PARAMS
- Show all CLI parameters, their provenance, defaults and value, then
exit.
- REFRESH_DIRECTIVES_TABLE_FORMAT
- Rendering style of tables.
- REFRESH_DIRECTIVES_VERBOSITY
- Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
- REFRESH_DIRECTIVES_VERBOSE
- REFRESH_DIRECTIVES_QUIET
- REFRESH_DIRECTIVES_MAN
- Show the command's man page (roff) and exit.
- REFRESH_DIRECTIVES_VERSION
- Show the version and exit.
- REFRESH_DIRECTIVES_HELP
- Show this message and exit.
~/.config/click-extra/{*.toml,*.yaml,*.yml,*.json,*.json5,*.jsonc,*.hjson,*.ini,*.xml,pyproject.toml}
- 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.