click-extra convert-to-myst - Convert reST docstrings to MyST
markdown in Python source files.
click-extra convert-to-myst [OPTIONS]
[DIRECTORY]
Convert reST docstrings to MyST markdown in Python source
files.
Transforms reST markup in docstrings and #: comment blocks to
MyST. The companion click_extra.sphinx.myst_docstrings Sphinx extension
converts the MyST back to reST at build time, so sphinx.ext.autodoc still
works.
If DIRECTORY is not specified, auto-detects the source package
directory from the project's script entry points in pyproject.toml.
Safe to re-run: already-converted MyST syntax does not match the
reST patterns, so the conversion is idempotent.
- [DIRECTORY]
- --config
LOCATION
- 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
LOCATION
- Validate the configuration file and exit.
- --export-config
FORMAT
- Export the configuration in the selected format to <stdout>, then
exit.
[values: toml, yaml, json, json5, jsonc, hjson, xml, plist]
- --accessible
- Accessibility mode: disable colors and render tables in a borderless,
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
[auto|dark|dracula|light|manpage|monokai|nord|solarized-dark]
- Color theme used for help screens.
- --table-format
FORMAT
- Rendering style of tables.
[values: 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]
- --verbosity
LEVEL
- Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
[values: CRITICAL, ERROR, WARNING, INFO, DEBUG]
- --verbose /
-v
- Increase the default WARNING verbosity by one level for each additional
repetition of the option.
- --quiet /
-q
- Decrease the default WARNING verbosity by one level for each additional
repetition of the option.
- --debug
- Shorthand for --verbosity DEBUG.
- CONVERT_TO_MYST__CLICK_DEFAULT_HELP
- Show this message and exit.
- CONVERT_TO_MYST_CONFIG
- Location of the configuration file. Supports local path with glob patterns
or remote URL.
- CONVERT_TO_MYST_VALIDATE_CONFIG
- Validate the configuration file and exit.
- CONVERT_TO_MYST_EXPORT_CONFIG
- Export the configuration in the selected format to <stdout>, then
exit.
- CONVERT_TO_MYST_ACCESSIBLE
- Accessibility mode: disable colors and render tables in a borderless,
screen-reader-friendly format.
- CONVERT_TO_MYST_COLOR
- Colorize the output. A bare --color is the same as --color=always.
- CONVERT_TO_MYST_NO_COLOR
- Disable colorization (alias of --color=never).
- CONVERT_TO_MYST_PROGRESS
- Show progress indicators during long operations. Disabled for
non-interactive output (pipes, dumb terminals, CI) and by
--accessible.
- CONVERT_TO_MYST_THEME
- Color theme used for help screens.
- CONVERT_TO_MYST_TABLE_FORMAT
- Rendering style of tables.
- CONVERT_TO_MYST_VERBOSITY
- Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
- CONVERT_TO_MYST_VERBOSE
- Increase the default WARNING verbosity by one level for each additional
repetition of the option.
- CONVERT_TO_MYST_QUIET
- Decrease the default WARNING verbosity by one level for each additional
repetition of the option.
- CONVERT_TO_MYST_DEBUG
- Shorthand for --verbosity DEBUG.
- CONVERT_TO_MYST_TIME
- Measure and print elapsed execution time.
- CONVERT_TO_MYST_PARAMS
- Show all CLI parameters, their provenance, defaults and value, then
exit.
- CONVERT_TO_MYST_TREE
- Show the tree of nested subcommands and exit.
- CONVERT_TO_MYST_MAN
- Read the command's manual page and exit.
- CONVERT_TO_MYST_HELP_FORMAT
- Render the command in the given format and exit.
- CONVERT_TO_MYST_VERSION
- Show the version and exit.
~/.config/click-extra/{*.toml,*.yaml,*.yml,*.json,*.json5,*.jwcc,*.jsonc,*.hjson,*.ini,*.xml,*.plist,*.sqlite,*.sqlite3,*.conf,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.