rtd¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Read the Docs interface
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ project-list Get a list of Read the Docs projects. │
│ project-details Get details for a specific Read the Docs project. │
│ project-create Create a new Read the Docs project. │
│ project-update Update an existing Read the Docs project. │
╰──────────────────────────────────────────────────────────────────────────────╯
Commands¶
project-list¶
Usage: lftools-uv rtd project-list [OPTIONS]
Get a list of Read the Docs projects.
Returns a list of RTD projects for the account whose token is configured in
lftools.ini. This returns the slug name, not the pretty name.
Examples: lftools-uv rtd project-list
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
project-details¶
Usage: lftools-uv rtd project-details [OPTIONS] PROJECT_SLUG
Get details for a specific Read the Docs project.
Args: project_slug: The slug name of the project
Examples: lftools-uv rtd project-details my-project
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * project_slug TEXT Project slug name │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
project-version-list¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-version-list'. Did you mean 'project-list'? │
╰──────────────────────────────────────────────────────────────────────────────╯
project-version-details¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-version-details'. Did you mean 'project-details'? │
╰──────────────────────────────────────────────────────────────────────────────╯
project-version-update¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-version-update'. Did you mean 'project-update', │
│ 'project-create'? │
╰──────────────────────────────────────────────────────────────────────────────╯
project-create¶
Usage: lftools-uv rtd project-create [OPTIONS] NAME REPO_URL
Create a new Read the Docs project.
Args: name: The name of the project repo_url: The repository URL description:
Project description (optional) language: Project language code (default: en)
Examples: lftools-uv rtd project-create "My Project"
https://github.com/user/repo lftools-uv rtd project-create "My Project"
https://github.com/user/repo --description "A great project"
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Project name │
│ [required] │
│ * repo_url TEXT Repository URL │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT Project description │
│ --language TEXT Project language code │
│ [default: en] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
project-build-list¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-build-list'. Did you mean 'project-list', │
│ 'project-update', 'project-details'? │
╰──────────────────────────────────────────────────────────────────────────────╯
project-build-details¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-build-details'. Did you mean 'project-details', │
│ 'project-list', 'project-update'? │
╰──────────────────────────────────────────────────────────────────────────────╯
project-build-trigger¶
Usage: lftools-uv rtd [OPTIONS] COMMAND [ARGS]...
Try 'lftools-uv rtd --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────╮
│ No such command 'project-build-trigger'. Did you mean 'project-update', │
│ 'project-list'? │
╰──────────────────────────────────────────────────────────────────────────────╯
API requires a [rtd] section in ~/.config/lftools/lftools.ini:
[rtd]
token = REDACTED
endpoint = https://readthedocs.org/api/v3/