#8161: use Sphinx to produce docstrings from the command line
-----------------------------+----------------------------------------------
Reporter: jhpalmieri | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.3.2
Component: documentation | Keywords:
Author: John Palmieri | Upstream: N/A
Reviewer: Mitesh Patel | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by jhpalmieri):
On further reflection, I've decided that replacing {{{``}}} with {{{"}}}
is a bad idea. It's complicated, and it can make some docstrings less
clear. For example, should {{{``"text"``}}} be turned into {{{"text"}}}
or {{{"'text'"}}}? What about {{{``algorithm="gap"``}}}: turn it into
{{{"algorithm='gap'"}}}? What about (from sage.interfaces.sage0.Sage) the
beautiful {{{``s('"x"')``}}}?
If we eventually decide this is a good idea, we can do it in another
ticket (or submit it as a possible customization for text output in
Sphinx), but I'm taking it out for now.
A few doctests in sage and sagenb need to be changed as a consequence; see
the new patches.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8161#comment:6>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" 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/sage-trac?hl=en.
