Readthedocs Plugin¶
-
class
sirbot.plugins.readthedocs.
RTDPlugin
[source]¶ Handle readthedocs webhook
Register a new handler with:
RTDPlugin.register_handler(project_name, handler)
- Endpoints:
/readthedocs
: Readthedocs webhook.
-
coroutine
build
(project, branch='latest')[source]¶ Trigger a build of project branch.
The project must first be registered with
register_project()
Parameters: - project – Readthedocs project name
- branch – Branch to build
Returns:
-
register_handler
(project, handler)[source]¶ Register a new project notification handler.
To setup a notification webhook go to the
admin > notifications
setting of your project readthedocs dashboardParameters: - project – Readthedocs project name.
- handler – Coroutine callback.
-
register_project
(project, build_url, jeton, handlers=None)[source]¶ Register a project
Find project information in the
admin > integration
section of your project readthedocs dashboard.Parameters: - project – Readthedocs project name
- build_url – Readthedocs project webhook
- jeton – Integration token
- handlers – Project notification handlers