From 20ef4d4a7aa791037b7eb177bc04f9053717af6d Mon Sep 17 00:00:00 2001 From: Thomas Sibley Date: Mon, 1 Jul 2019 10:24:01 -0700 Subject: [PATCH] Docs: Reorganize usage docs to fit better into the new usage/development split --- docs/cli.rst | 9 +++------ docs/examples.rst | 6 +++--- docs/index.rst | 3 +-- docs/usage.rst | 9 +++++++++ 4 files changed, 16 insertions(+), 11 deletions(-) create mode 100644 docs/usage.rst diff --git a/docs/cli.rst b/docs/cli.rst index f6db8aed6..a7e696064 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -1,15 +1,12 @@ -=========== -Using Augur -=========== +============= +Augur command +============= All of Augur's commands are accessed through the ``augur`` program. For example, to infer ancestral sequences from a tree, you'd run ``augur ancestral``. Each command is documented below. You can also run each command with the ``--help`` option, for example ``augur tree --help``, for more information at the command-line. -Augur command -============= - .. argparse:: :module: augur :func: make_parser diff --git a/docs/examples.rst b/docs/examples.rst index 914b6223a..3afd19883 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,6 +1,6 @@ -======================= -Examples of using Augur -======================= +============================= +Examples of Augur in the wild +============================= We really enjoy hearing about people using Augur. If you use Augur to do your work, we'd love to add it to this page! Let us know about it by `opening an diff --git a/docs/index.rst b/docs/index.rst index 4bc6074ec..cb1bf0f4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,6 @@ Augur originated as part of `Nextstrain `__, an open-sou :caption: Table of contents installation - cli + usage api - examples authors diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 000000000..ef7da02e2 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,9 @@ +=========== +Using Augur +=========== + +.. toctree:: + :maxdepth: 3 + + cli + examples