Update wording around regenerating developer API docs

The old wording said "automatic" which is not entirely accurate since you still have to manually commit and push the changes.
nextstrain · Jul 10, 2024 · 6c75a8b · 6c75a8b
1 parent 6ca5cce
commit 6c75a8b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -219,7 +219,7 @@ jobs:
 
       - run: pip install .[dev]
 
-      - run: ./devel/generate-developer-api-docs
+      - run: ./devel/regenerate-developer-api-docs
 
       - name: Check for changes
         run: |

diff --git a/devel/generate-developer-api-docs → devel/regenerate-developer-api-docs b/devel/generate-developer-api-docs → devel/regenerate-developer-api-docs
diff --git a/docs/contribute/DEV_DOCS.md b/docs/contribute/DEV_DOCS.md
@@ -324,13 +324,13 @@ file in order to render the pages.
   reStructuredText file should be added under `docs/usage/cli/` in addition to
   the new file under `docs/api/`.
 
-### Automatically updating developer API docs
+### Regenerating developer API docs
 
-To update the developer API documentation after adding or removing an augur submodule,
-autogenerate a new API file as follows.
+To regenerate the developer API documentation after adding, renaming, or removing an augur
+submodule, autogenerate a new API file as follows.
 
 ```bash
-./devel/generate-developer-api-docs
+./devel/regenerate-developer-api-docs
 ```
 
 ### Building documentation