Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #6

Merged
merged 6 commits into from May 3, 2017
Merged

Documentation #6

merged 6 commits into from May 3, 2017

Conversation

ghost
Copy link

@ghost ghost commented Jan 5, 2017

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.

embrown added 6 commits Nov 14, 2016
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 ghost requested a review from doutriaux1 Jan 5, 2017
@doutriaux1
Copy link
Contributor

doutriaux1 commented Mar 23, 2017

@dnadeau4 i'll let you handle this one

@doutriaux1 doutriaux1 merged commit 3dfa7be into CDAT:master May 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant