repo_helper_rtd¶

Manage ReadTheDocs documentation with repo-helper.

Docs
Tests
PyPI
Activity
QA
Other

Installation¶

python3 -m pip install repo_helper_rtd --user

python3 -m pip install git+https://github.com/repo-helper/repo_helper_rtd@master --user

Contents¶

Usage¶

repo-helper rtd¶

Manage a ReadTheDocs project.

repo-helper rtd [OPTIONS] COMMAND [ARGS]...

Options

--version¶: Show the version and exit.

Commands¶

new¶

Create a new ReadTheDocs project.

repo-helper rtd new [OPTIONS]

Options

-t, --token <token>¶: Required The token to authenticate with the ReadTheDocs API. Can also be provided via the ‘RTD_TOKEN’ environment variable.

--colour, --no-colour¶: Whether to use coloured output.

Environment variables

RTD_TOKEN: Provides a default for -t / --token

update¶

Update the ReadTheDocs project.

repo-helper rtd update [OPTIONS]

Options

-t, --token <token>¶: Required The token to authenticate with the ReadTheDocs API. Can also be provided via the ‘RTD_TOKEN’ environment variable.

--colour, --no-colour¶: Whether to use coloured output.

Environment variables

RTD_TOKEN: Provides a default for -t / --token

Public API¶

Manage ReadTheDocs documentation with repo-helper.

Classes:

ReadTheDocsManager(token, target_repo[, …])

Subclass of repo_helper.core.RepoHelper with additional functions to update ReadTheDocs projects.

class ReadTheDocsManager(token, target_repo, managed_message="This file is managed by 'repo_helper'. Don't edit it directly.", *, colour=True)[source]¶

Bases: RepoHelper

Subclass of repo_helper.core.RepoHelper with additional functions to update ReadTheDocs projects.

Parameters

token (str) – The token to authenticate with the ReadTheDocs API.
target_repo (Union[str, Path, PathLike]) – The path to the root of the repository to manage files for.
managed_message – Message placed at the top of files to indicate that they are managed by repo_helper. Default "This file is managed by 'repo_helper'. Don't edit it directly.".
colour (Optional[bool]) – Whether to use coloured output. Default True.

Changed in version 0.2.3: Added the verbose and colour options.

Attributes:

colour

Whether to use coloured output.

Methods:

`get_update_json`()	Returns the body JSON used to update the project.
`new`()	Import this project into ReadTheDocs.
`update`()	Update this project on ReadTheDocs.

colour¶

Type: Optional[bool]

Whether to use coloured output.

get_update_json()[source]¶

Returns the body JSON used to update the project.

Return type: Dict[str, Union[Dict[str, str], str]]

new()[source]¶

Import this project into ReadTheDocs.

Return type: Response

update()[source]¶

Update this project on ReadTheDocs.

Return type: Response

Downloading source code¶

The repo_helper_rtd source code is available on GitHub, and can be accessed from the following URL: https://github.com/repo-helper/repo_helper_rtd

If you have git installed, you can clone the repository with the following command:

git clone https://github.com/repo-helper/repo_helper_rtd

Cloning into 'repo_helper_rtd'...
remote: Enumerating objects: 47, done.
remote: Counting objects: 100% (47/47), done.
remote: Compressing objects: 100% (41/41), done.
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
Resolving deltas: 100% (66/66), done.

Alternatively, the code can be downloaded in a ‘zip’ file by clicking:

Clone or download –> Download Zip

Downloading a ‘zip’ file of the source code¶

Building from source¶

The recommended way to build repo_helper_rtd is to use tox:

tox -e build

The source and wheel distributions will be in the directory dist.

If you wish, you may also use pep517.build or another PEP 517-compatible build tool.

License¶

repo_helper_rtd is licensed under the MIT License

A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Permissions	Conditions	Limitations
Commercial use Modification Distribution Private use	License and copyright notice	Liability Warranty

See more information on choosealicense.com ➩

Copyright (c) 2020 Dominic Davis-Foster

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.

View the Function Index or browse the Source Code.

Browse the GitHub Repository