Public API¶
Manage ReadTheDocs documentation with repo-helper
.
Classes:
|
Subclass of |
-
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. DefaultTrue
.
Changed in version 0.2.3: Added the
verbose
andcolour
options.Attributes:
Whether to use coloured output.
Methods:
Returns the body JSON used to update the project.
new
()Import this project into ReadTheDocs.
update
()Update this project on ReadTheDocs.