#7120: [with patch, needs review] document Sphinx/reST markup for INPUT/OUTPUT
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: jhpalmieri
Type: enhancement | Status: new
Priority: minor | Milestone: sage-4.1.3
Component: documentation | Keywords:
Reviewer: | Author: John Palmieri
Merged: |
---------------------------+------------------------------------------------
Instead of using
{{{
INPUT:
- ``x`` - integer (default: 1) blah
}}}
Sphinx has specific markup for this:
{{{
:param x: blah
:type x: integer, default 1
}}}
The resulting output isn't quite the same, but it looks nice.
There are two patches here; one adds a little to the developer's guide to
document this. The other patch implements this (applied to the file
sage/homology/simplicial_complex.py) so you can build the documentation
and see what it looks like. The patches are independent; either or both
could be merged, although it would not really accomplish the purpose of
the ticket to just merge the simplicial complex patch...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7120>
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
-~----------~----~----~----~------~----~------~--~---
