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-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

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 a list of RTD projects for the account whose[0m[2m [0m[2mtoken is configured in [0m   
 [2mlftools.ini. This returns the[0m[2m [0m[2mslug name, not the pretty name.[0m                  
                                                                                
 [2mExamples:[0m[2m [0m[2mlftools-uv rtd project-list[0m                                          
                                                                                
[2m╭─[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[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.                              
                                                                                
 [2mArgs:[0m[2m [0m[2mproject_slug: The slug name of the project[0m                               
                                                                                
 [2mExamples:[0m[2m [0m[2mlftools-uv rtd project-details my-project[0m                            
                                                                                
[2m╭─[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m    project_slug      [1;33mTEXT[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-help[0m          Show this message and exit.                                  [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-version-list¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-version-list'. Did you mean 'project-list'?         [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-version-details¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-version-details'. Did you mean 'project-details'?   [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-version-update¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-version-update'. Did you mean 'project-update',     [31m│[0m
[31m│[0m 'project-create'?                                                            [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-create¶

[1m                                                                                [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv rtd project-create [OPTIONS] NAME REPO_URL[0m[1m                  [0m[1m [0m
[1m                                                                                [0m
 Create a new Read the Docs project.                                            
                                                                                
 [2mArgs:[0m[2m [0m[2mname: The name of the project[0m[2m [0m[2mrepo_url: The repository URL[0m[2m [0m[2mdescription: [0m 
 [2mProject description (optional)[0m[2m [0m[2mlanguage: Project language code (default: en)[0m   
                                                                                
 [2mExamples:[0m[2m [0m[2mlftools-uv rtd project-create "My Project" [0m                          
 [2mhttps://github.com/user/repo[0m[2m [0m[2mlftools-uv rtd project-create "My Project" [0m       
 [2mhttps://github.com/user/repo --description "A great project"[0m                   
                                                                                
[2m╭─[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m    name          [1;33mTEXT[0m  Project name                                        [2m│[0m
[2m│[0m                          [2;31m[required]                                         [0m [2m│[0m
[2m│[0m [31m*[0m    repo_url      [1;33mTEXT[0m  Repository URL                                      [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-description[0m        [1;33mTEXT[0m  Project description                               [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-language[0m           [1;33mTEXT[0m  Project language code                             [2m│[0m
[2m│[0m                            [2m[default: en]                                    [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m               [1;33m    [0m  Show this message and exit.                       [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-build-list¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-build-list'. Did you mean 'project-list',           [31m│[0m
[31m│[0m 'project-update', 'project-details'?                                         [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-build-details¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-build-details'. Did you mean 'project-details',     [31m│[0m
[31m│[0m 'project-list', 'project-update'?                                            [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

project-build-trigger¶

[33mUsage: [0mlftools-uv rtd [OPTIONS] COMMAND [ARGS]...
[2mTry [0m[2;34m'lftools-uv rtd [0m[1;2;34m-[0m[1;2;34m-help[0m[2;34m'[0m[2m for help.[0m
[31m╭─[0m[31m Error [0m[31m─────────────────────────────────────────────────────────────────────[0m[31m─╮[0m
[31m│[0m No such command 'project-build-trigger'. Did you mean 'project-update',      [31m│[0m
[31m│[0m 'project-list'?                                                              [31m│[0m
[31m╰──────────────────────────────────────────────────────────────────────────────╯[0m

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

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