Skip to content

Commit

Permalink
Clarify doc update instructions
Browse files Browse the repository at this point in the history
Update the developer API path and reference the script.
  • Loading branch information
victorlin committed Jul 10, 2024
1 parent 6c75a8b commit 070a639
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/contribute/DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,10 +319,11 @@ Python file must be accompanied by at least one corresponding reStructuredText
file in order to render the pages.
- If a new Python file is added, a new reStructuredText file should be added
under `docs/api/`.
under `docs/api/developer`. This can be done
[using a script](#regenerating-developer-api-docs).
- If the new Python file represents a subcommand of `augur`, a new
reStructuredText file should be added under `docs/usage/cli/` in addition to
the new file under `docs/api/`.
the new file under `docs/api/developer`.
### Regenerating developer API docs
Expand Down

0 comments on commit 070a639

Please sign in to comment.