#10474: sphinxify() text-mode fails on definition within list item
-----------------------------+----------------------------------------------
Reporter: kini | Owner: mvngu
Type: defect | Status: new
Priority: major | Milestone:
Component: documentation | Keywords: sagedoc, sphinxify, sphinx,
restructuredtext
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
As the title suggests, `sage.misc.sagedoc.sphinxify(s, format="text")`
returns an empty string when `s` contains a line that begins a list item
(such as `"- foo"`, `"* foo"`, `"1. foo"`, etc.) immediately followed by a
line with greater indentation than the first (such as `" bar"`, `"
bar"`, and `" bar"` respectively). However, calling the function
without the option `format="text"` returns (slightly broken) HTML
reflecting a reasonable interpretation of the input string.
{{{
sage: sage.misc.sagedoc.sphinxify("- foo\n bar")
'<div class="docstring">\n \n <ul>\n<li><dl class="first
docutils">\n<dt>foo</dt>\n<dd><p class="first
last">bar</p>\n</dd>\n</dl>\n</li>\n</ul>\n\n\n</div>'
sage: sage.misc.sagedoc.sphinxify("- foo\n bar", format="text")
''
}}}
The above snippet is from a sage 4.6 interpreter session.
I'm not too sure, but after some digging around in sage, it *looks* like
this is a sphinx issue, but I thought I should report it here first
anyway, just in case...
The expected behavior, I would think, would be either for both text mode
and html mode to refuse to interpret the string, or for both of them to
parse it in similar ways.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10474>
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.