#11251: Add todo extension to Sphinx
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: hivert
Type: enhancement | Status: positive_review
Priority: major | Milestone: sage-4.7.1
Component: documentation | Keywords: todo sphinx days30
Work_issues: | Upstream: N/A
Reviewer: John Palmieri | Author: Florent Hivert
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Changes (by jhpalmieri):
* status: needs_review => positive_review
* reviewer: => John Palmieri
Comment:
Introspection works, but isn't perfect. I think it's good enough for now,
but it might be nice to try to figure out what's wrong eventually. In
particular: look at a docstring with a ".. todo" markup in these four
ways:
- in the reference manual: it looks great. "TODO" is in bold, and the
whole block has a different background color.
- in the notebook (by typing {{{sage.combinat.combinat?}}}, for example):
it looks okay. "TODO" is not in bold, and the block has the same
background color as the rest of the docstring.
- from the command line, using {{{...?}}}: it looks as good as can be
expected, since it's plain text.
- from the command line, using
{{{browse_sage_doc(sage.combinat.combinat)}}}: it looks pretty good, in
between the reference manual and the notebook: "TODO" is in bold, but the
background color is white.
I tried modifying sphinxify.py and it didn't seem to have any effect. If
only there were some way to add something like this to a "to do list"...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11251#comment:16>
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.
