xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 04:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1795 from jmsb02/docs/add_docs-auto-trigger-docs-only

Browse Source 
docs: document how to auto-trigger /add_docs via pr_commands
This commit is contained in:
Tal
2025-05-19 21:30:05 +03:00
committed by GitHub
parent 9464fd9696 a315779713
commit 6d9bb93f62
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/docs/tools/documentation.md
View File

@ -26,6 +26,29 @@ You can state a name of a specific component in the PR to get documentation only
/add_docs component_name /add_docs component_name
``` ```
## Manual triggering
Comment `/add_docs` on a PR to invoke it manually.
## Automatic triggering
To automatically run the `add_docs` tool when a pull request is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/):
```toml
[github_app]
pr_commands = [
"/add_docs",
...
]
```
The `pr_commands` list defines commands that run automatically when a PR is opened.
Since this is under the [github_app] section, it only applies when using the Qodo Merge GitHub App in GitHub environments.
!!! note
By default, /add_docs is not triggered automatically. You must explicitly include it in pr_commands to enable this behavior.
## Configuration options ## 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`. - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.