Skip to content

Commit

Permalink
dev: Explain generated rST source documentation files for `nextstrain…
Browse files Browse the repository at this point in the history
…` commands

Prompted to add this by @joverlee521 in post-merge review; thanks!
  • Loading branch information
tsibley committed Jul 24, 2023
1 parent 20bd728 commit e2420d4
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,20 @@ To locally build the HTML version of the documentation (i.e. what's served at
This will start a server on <http://localhost:8000> which you can browse.
Changes to source documentation files will be reflected automatically.

The rST source documentation files for the individual `nextstrain` commands are
generated from the Python source files and checked into version control.
Changes should be kept in sync by regenerating with:

$ ./devel/generate-command-doc

This will emit the file paths it updates, if any. This also happens
automatically as part of the documentation build process to ensure the built
docs always reflect the current source. Tests run in CI ensure the generated
files are current and don't vary based on ambient environmental factors.

The `devel/generate-command-doc` program also has `--diff` and `--check` modes
which may be helpful during development; see `--help` for details.


[Semantic Versioning rules]: https://semver.org
[nextstrain.org server]: https://github.com/nextstrain/nextstrain.org
Expand Down

0 comments on commit e2420d4

Please sign in to comment.