ReadTheDocs

Usage: lftools rtd [OPTIONS] COMMAND [ARGS]...

  Read the Docs interface.

Options:
  --help  Show this message and exit.

Commands:
  project-build-details    Retrieve specific project build details.
  project-build-list       Retrieve a list of a project's builds.
  project-build-trigger    Trigger a new build.
  project-create           Create a new project.
  project-details          Retrieve project details.
  project-list             Get a list of Read the Docs projects.
  project-update           Create a new project.
  project-version-details  Retrieve project version details.
  project-version-list     Retrieve project version list.
  project-version-update   Update projects active version.
  subproject-create        Create a project-subproject relationship.
  subproject-delete        Delete a project-subproject relationship.
  subproject-details       Retrieve subproject's details.
  subproject-list          Get a list of Read the Docs subprojects for a...

Commands

project-list

Usage: lftools 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.

Options:
  --help  Show this message and exit.

project-details

Usage: lftools rtd project-details [OPTIONS] PROJECT_SLUG

  Retrieve project details.

Options:
  --help  Show this message and exit.

project-version-list

Usage: lftools rtd project-version-list [OPTIONS] PROJECT_SLUG

  Retrieve project version list.

Options:
  --help  Show this message and exit.

project-version-details

Usage: lftools rtd project-version-details [OPTIONS] PROJECT_SLUG VERSION_SLUG

  Retrieve project version details.

Options:
  --help  Show this message and exit.

project-version-update

Usage: lftools rtd project-version-update [OPTIONS] PROJECT_SLUG VERSION_SLUG
                                          ACTIVE

  Update projects active version.

  active must be one of true or false

Options:
  --help  Show this message and exit.

project-create

Usage: lftools rtd project-create [OPTIONS] PROJECT_NAME REPOSITORY_URL
                                  REPOSITORY_TYPE HOMEPAGE
                                  PROGRAMMING_LANGUAGE LANGUAGE

  Create a new project.

Options:
  --help  Show this message and exit.

project-build-list

Usage: lftools rtd project-build-list [OPTIONS] PROJECT_SLUG

  Retrieve a list of a project's builds.

Options:
  --help  Show this message and exit.

project-build-details

Usage: lftools rtd project-build-details [OPTIONS] PROJECT_SLUG BUILD_ID

  Retrieve specific project build details.

Options:
  --help  Show this message and exit.

project-build-trigger

Usage: lftools rtd project-build-trigger [OPTIONS] PROJECT_SLUG VERSION_SLUG

  Trigger a new build.

Options:
  --help  Show this message and exit.

API requires a [rtd] section in ~/.config/lftools/lftools.ini:

[rtd]
token = REDACTED
endpoint = https://readthedocs.org/api/v3/