Documentation

THIS SECTION IS UNDER CONSTRUCTION.

If you have questions or would like to help please open an issue on GitHub.

These commands are used to build and view Augur’s documentation. Before making any documentation changes, please read the documentation guide.

`make docs`

Generate both library and API documentation.

Example:

$ make docs

Generate the library documentation (the documentation you’re reading).

Example:

$ make library-docs

Generate the library documentation, and automatically open a new browser tab to view it.

Example:

$ make library-docs-view

Generate the API documentation.

Example:

$ make api-docs

Generate the API documentation, and automatically open a new browser tab to view it.

Example:

$ make api-docs-view