From 070a6394ee100741f68b3cb116a4f991e2b76690 Mon Sep 17 00:00:00 2001 From: Victor Lin <13424970+victorlin@users.noreply.github.com> Date: Wed, 10 Jul 2024 13:52:11 -0700 Subject: [PATCH] Clarify doc update instructions Update the developer API path and reference the script. --- docs/contribute/DEV_DOCS.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contribute/DEV_DOCS.md b/docs/contribute/DEV_DOCS.md index dd9f5750b..bedfd695e 100644 --- a/docs/contribute/DEV_DOCS.md +++ b/docs/contribute/DEV_DOCS.md @@ -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