diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 2f6c89e5a..82ea46e28 100644 --- 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 b/devel/regenerate-developer-api-docs similarity index 100% rename from devel/generate-developer-api-docs rename to devel/regenerate-developer-api-docs diff --git a/docs/contribute/DEV_DOCS.md b/docs/contribute/DEV_DOCS.md index a76ecf2fc..dd9f5750b 100644 --- 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