rtd¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...[0m[1m [0m[1m [0m
[1m [0m
Read the Docs interface.
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36mproject-list [0m[1;36m [0m Get a list of Read the Docs projects. [2m│[0m
[2m│[0m [1;36mproject-details [0m[1;36m [0m Get details for a specific Read the Docs project. [2m│[0m
[2m│[0m [1;36mproject-create [0m[1;36m [0m Create a new Read the Docs project. [2m│[0m
[2m│[0m [1;36mproject-update [0m[1;36m [0m Update an existing Read the Docs project. [2m│[0m
[2m│[0m [1;36mproject-version-list [0m[1;36m [0m Retrieve the active versions of a project. [2m│[0m
[2m│[0m [1;36mproject-version-details [0m[1;36m [0m Retrieve details of a single version. [2m│[0m
[2m│[0m [1;36mproject-version-update [0m[1;36m [0m Update a version's active flag. [2m│[0m
[2m│[0m [1;36mproject-build-list [0m[1;36m [0m Retrieve a project's running builds. [2m│[0m
[2m│[0m [1;36mproject-build-details [0m[1;36m [0m Retrieve the details of a specific build. [2m│[0m
[2m│[0m [1;36mproject-build-trigger [0m[1;36m [0m Trigger a build of a project version. [2m│[0m
[2m│[0m [1;36msubproject-list [0m[1;36m [0m Get a list of subprojects for a project. [2m│[0m
[2m│[0m [1;36msubproject-details [0m[1;36m [0m Retrieve the details of a specific subproject. [2m│[0m
[2m│[0m [1;36msubproject-create [0m[1;36m [0m Create a project/subproject relationship. [2m│[0m
[2m│[0m [1;36msubproject-delete [0m[1;36m [0m Delete a project/subproject relationship. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
Machine-readable output¶
Every command accepts --json and emits a parsable payload on
stdout. Diagnostics go to stderr, so a caller may parse stdout without
a warning corrupting the stream.
lftools-uv rtd project-version-details onap-cps latest --json | jq '.active'
The flag works before or after the subcommand:
lftools-uv rtd --json project-list
lftools-uv rtd project-list --json
Commands that return a collection always include the collection in the
--json payload, empty when nothing matches, so a parser needs no
special case for the empty result. Table output prints a short message
such as No projects found instead.
Branch names and version slugs¶
Read the Docs addresses a version by its slug, which lowercases the
branch name and replaces every character outside [a-z0-9._-] with a
hyphen. Read the Docs holds a branch named maintenance/3.7.10 under
the slug maintenance-3.7.10.
Passing a raw branch name to the API produces a request path that does
not resolve. Commands that accept a version offer --from-branch,
which performs the conversion:
lftools-uv rtd project-build-trigger onap-cps maintenance/3.7.10 --from-branch
Omit the flag when you already hold a slug.
Commands¶
project-list¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-list [OPTIONS][0m[1m [0m[1m [0m
[1m [0m
Get a list of Read the Docs projects.
[2mReturns projects by their slug name, not their pretty name, since[0m[2m [0m[2mthe slug is [0m
[2mwhat other commands accept.[0m
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-list[0m[2m [0m[2mlftools-uv rtd project-list --json[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-details¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-details [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m
Get details for a specific Read the Docs project.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-details onap-cps[0m[2m [0m[2mlftools-uv rtd [0m
[2mproject-details onap-cps --json[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-create¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-create [OPTIONS] {project_name} {repository_url}[0m[1m [0m
[1m [0m[1m {repository_type} {homepage}[0m[1m [0m[1m [0m
[1m [0m[1m {programming_language} {language}[0m[1m [0m[1m [0m
[1m [0m
Create a new Read the Docs project.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-create onap-cps https://example.org/cps git [0m
[2mhttps://onap-cps.readthedocs.io py en[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_name [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repository_url [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Repository URL [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repository_type [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Repository type: git, hg, bzr or svn [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m homepage [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project homepage URL [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m programming_language [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Programming language abbreviation, [2m│[0m
[2m│[0m e.g. py [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m language [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Two-letter language code, e.g. en [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-update¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-update [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m
Update an existing Read the Docs project.
[2mAccepts any number of [0m[1;2;36;40mkey=value[0m[2m pairs matching the fields the[0m[2m [0m[2mRead the Docs [0m
[2mAPI allows.[0m
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-update onap-cps default_version=latest[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-version-list¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-version-list [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m
Retrieve the active versions of a project.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-version-list onap-cps[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-version-details¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-version-details [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {VERSION_SLUG}[0m[1m [0m[1m [0m
[1m [0m
Retrieve details of a single version.
[2mRead the Docs addresses a version by its slug, so a branch named[0m[2m [0m
[1;2;36;40mmaintenance/3.7.10[0m[2m is stored as [0m[1;2;36;40mmaintenance-3.7.10[0m[2m. Pass[0m[2m [0m[1;2;36;40m--from-branch[0m[2m to [0m
[2mconvert a branch name automatically.[0m
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-version-details onap-cps latest[0m[2m [0m[2mlftools-uv [0m
[2mrtd project-version-details onap-cps maintenance/3.7.10 --from-branch[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m VERSION_SLUG [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Version slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-from[0m[1;36m-branch[0m Treat VERSION_SLUG as a git branch name and slugify [2m│[0m
[2m│[0m it first. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-version-update¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-version-update [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {VERSION_SLUG} {active}[0m[1m [0m[1m [0m
[1m [0m
Update a version's active flag.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-version-update onap-cps maintenance/3.7.10 [0m
[2mtrue --from-branch[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m VERSION_SLUG [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Version slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m active [1;33m [0m Whether the version should be active [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-from[0m[1;36m-branch[0m Treat VERSION_SLUG as a git branch name and slugify [2m│[0m
[2m│[0m it first. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-build-list¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-build-list [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m
Retrieve a project's running builds.
[2mWith [0m[1;2;36;40m--json[0m[2m the payload always carries a [0m[1;2;36;40mbuilds[0m[2m list, empty[0m[2m [0m[2mwhen nothing is [0m
[2mrunning, so a caller can parse the result without a[0m[2m [0m[2mspecial case. Table output[0m
[2mprints a short message instead.[0m
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-build-list onap-cps --json[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-build-details¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-build-details [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {build_id}[0m[1m [0m[1m [0m
[1m [0m
Retrieve the details of a specific build.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-build-details onap-cps 9584913 --json[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m build_id [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Build identifier [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
project-build-trigger¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-build-trigger [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {VERSION_SLUG}[0m[1m [0m[1m [0m
[1m [0m
Trigger a build of a project version.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd project-build-trigger onap-cps latest[0m[2m [0m[2mlftools-uv rtd [0m
[2mproject-build-trigger onap-cps maintenance/3.7.10 --from-branch[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m VERSION_SLUG [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Version slug to build [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-from[0m[1;36m-branch[0m Treat VERSION_SLUG as a git branch name and slugify [2m│[0m
[2m│[0m it first. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
subproject-list¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd subproject-list [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m
Get a list of subprojects for a project.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd subproject-list onap[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Parent project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
subproject-details¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd subproject-details [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {subproject_slug}[0m[1m [0m[1m [0m
[1m [0m
Retrieve the details of a specific subproject.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd subproject-details onap onap-cps --json[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Parent project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m subproject_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Subproject slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
subproject-create¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd subproject-create [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {subproject_slug}[0m[1m [0m[1m [0m
[1m [0m
Create a project/subproject relationship.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd subproject-create onap onap-cps[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Parent project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m subproject_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Subproject slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-alias[0m [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Optional user-defined alias [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m [1;33m [0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
subproject-delete¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd subproject-delete [OPTIONS] {project_slug}[0m[1m [0m[1m [0m
[1m [0m[1m {subproject_slug}[0m[1m [0m[1m [0m
[1m [0m
Delete a project/subproject relationship.
[2mExamples:[0m[2m [0m[2mlftools-uv rtd subproject-delete onap onap-cps[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m project_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Parent project slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m subproject_slug [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Subproject slug name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-json[0m Emit machine-readable JSON instead of a table. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
Configuration¶
API requires a [rtd] section in ~/.config/lftools/lftools.ini:
[rtd]
token = REDACTED
endpoint = https://readthedocs.org/api/v3/