Skip to content

Commit

Permalink
Docs: Reorganize usage docs to fit better into the new usage/developm…
Browse files Browse the repository at this point in the history
…ent split
  • Loading branch information
tsibley committed Jul 1, 2019
1 parent 825fb58 commit 20ef4d4
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 11 deletions.
9 changes: 3 additions & 6 deletions docs/cli.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Augur originated as part of `Nextstrain <https://nextstrain.org>`__, an open-sou
:caption: Table of contents

installation
cli
usage
api
examples
authors
9 changes: 9 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===========
Using Augur
===========

.. toctree::
:maxdepth: 3

cli
examples

0 comments on commit 20ef4d4

Please sign in to comment.