Documentation #6
Merged
Conversation
This file contains 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
added 6 commits
November 14, 2016 11:11
sphinx-compatible. Not as much has been done with cdutil as was done in genutil, but much of the documentation has been converted to RST format, there are :Example: sections in a lot of places, and there is a sphinx configuration that makes it possible to build pdf/html output for the documentation. As with genutil, cdutil needs an experienced eye to go over the documentation and fill in parameter/return descriptions/datatypes. It also needs working :Examples: that will pass doctests.
ghost
requested a review
from 
|
@dnadeau4 i'll let you handle this one |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This contains a lot of documentation edits to make docstrings sphinx-compatible.
Not as much has been done with cdutil as was done in genutil, but much of the
documentation has been converted to RST format, there are :Example: sections
in a lot of places, and there is a sphinx configuration that makes it possible
to build pdf/html output for the documentation.
As with genutil, cdutil needs an experienced eye to go over the documentation
and fill in parameter/return descriptions/datatypes. It also needs working
:Examples: that will pass doctests.