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

Refactor markdown image syntax and enhance documentation presentation

Browse Source
This commit is contained in:
Almog Lavi
2024-03-26 23:00:57 +02:00
parent 26c4a98fc8
commit 736c8a6953
21 changed files with 96 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,11 +7,11 @@ It can be invoked manually by commenting on any PR:
```
For example:
<kbd><img src=https://codium.ai/images/pr_agent/docs_command.png width="768"></kbd>
![Docs command](https://codium.ai/images/pr_agent/docs_command.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/docs_components.png width="768"></kbd>
![Docs component](https://codium.ai/images/pr_agent/docs_components.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/docs_single_component.png width="768"></kbd>
![Docs single component](https://codium.ai/images/pr_agent/docs_single_component.png){width=768}
## 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`.