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 #7

Merged
merged 5 commits into from May 3, 2017
Merged

Documentation #7

merged 5 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.

Most of the docstrings are in RST format, and many have :Example: sections with doctests meant to show usage examples for the code.

This is just the beginning phase of updating the documentation. What needs to happen next is that someone familiar with the library and its functions (parameters, return values, etc.) needs to fill in missing param/type and return/rtype. The :Examples: need to be edited such that they would actually run if you copied them into a python console. We also need to add a sphinx configuration to the Doc folder so we can start building a webpage/pdf manual.

xmldocs isn't actually being used yet, but there are at least a few places where we could plug repetetive parameters into the documentation, so it's a good idea.

embrown added 5 commits Sep 29, 2016
…compatible.

Most of the docstrings are in RST format, and many have :Example: sections with
doctests meant to show usage examples for the code.
This is just the beginning phase of updating the documentation.
What needs to happen next is that someone familiar with the library and its functions
(parameters, return values, etc.) needs to fill in missing param/type and return/rtype.
The :Examples: need to be edited such that they would actually run if you copied
them into a python console. We also need to add a sphinx configuration to the
Doc folder so we can start building a webpage/pdf manual.
@ghost ghost requested a review from doutriaux1 Jan 5, 2017
@doutriaux1 doutriaux1 merged commit 0c591f9 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