Update API docs - #687
Merged
Merged
Conversation
Adds docs for newer modules include index, util_support, and previously undocumented import module. Also, fixes a docstring in the index module that prevented proper rendering of doctests.
It helps to include the documentation along with their includes in the TOC.
Adds the basic command line usage directive and a brief example from the Zika tutorial.
eharkins
approved these changes
Feb 26, 2021
eharkins
left a comment
eharkins
left a comment
Contributor
There was a problem hiding this comment.
Looks good, just left a note about the interaction between this and nextstrain/docs.nextstrain.org#48.
Use the most recent Zika tutorial link instead of one that will soon be deprecated (and redirect to this link anyway). Co-authored-by: Elias Harkins <eli.harkins@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds API docs for newer modules include index, util_support, and previously undocumented import module. Also, fixes a docstring in the index module that prevented proper rendering of doctests.