Script to generate API documentation #139
Merged
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.
Also includes the generated docs. The API docs use
automodule
which means they will always be built from the last released version.For prettifying, some things in the docstrings will have to be changed, e.g @param and @author tags
For author tags, use field lists (
:author: Name
, see http://sphinx-doc.org/markup/misc.html#file-wide-metadata)See also: http://sphinx-doc.org/domains.html#the-python-domain (especially the "into fields list" section)