From 31620a82c04b0b40ea55b398e6ad5bf83f18401c Mon Sep 17 00:00:00 2001 From: jaexxin Date: Mon, 19 May 2025 17:34:48 +0900 Subject: [PATCH] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 247d5d6d..293cabb0 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -26,6 +26,25 @@ You can state a name of a specific component in the PR to get documentation only /add_docs component_name ``` +## Automatic triggering + +To automatically run the `add_docs` tool when a pull request is opened, configure your `.pr_agent.yaml` or `configuration.toml` as follows: + +```toml +[github_app] +pr_commands = [ + "/describe", + "/review", + "/improve", + "/add_docs" +] +``` + +!!! note + This behavior is **opt-in**; by default `/add_docs` only runs on manual invocation. + + + ## Configuration options - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.