Document how to update API documentation

Describes how to reflect the addition or removal of new augur submodules in the documentation.
nextstrain · May 24, 2019 · 022980e · 022980e
1 parent faed39b
commit 022980e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -174,6 +174,10 @@ You can see other available formats by running:
 
     make -C docs help
 
+To update the API documentation after adding or removing an augur submodule, autogenerate a new API file as follows.
+
+    sphinx-apidoc -T -f -o docs augur
+
 ## License and copyright
 
 Copyright 2014-2019 Trevor Bedford and Richard Neher.