Status: Accepted
Owner: ----
Labels: Type-Defect Priority-Medium CodeInCategory-Documentation CodeInDifficulty-Medium CodeInMultiple Documentation

New issue 2888 by [email protected]: Fix docstrings to work with Sphinx
http://code.google.com/p/sympy/issues/detail?id=2888

This is somewhat blocked on issue 2597, but there are docs already in Sphinx that need fixing too.

Basically, all docs should look good in Sphinx, and also in plain text. With the numpydoc extension, many things are automatically converted to Sphinx. These should not use Sphinx syntax, since this looks better in plain text. Also, headings should be underlined with =, like

Examples
========

And of course, there should be no warnings when the docs build.

For Code-In, create one task per module.

--
You received this message because you are subscribed to the Google Groups 
"sympy-issues" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sympy-issues?hl=en.

Reply via email to