#8244: Annoying warnings when building the HTML reference manual
-----------------------------+----------------------------------------------
Reporter: mpatel | Owner: mvngu
Type: defect | Status: new
Priority: major | Milestone: sage-4.3.3
Component: documentation | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by jhpalmieri):
This is great progress. By the way, I know how to fix the warnings for
{{{sage.misc.sagedoc.process_dollars}}}: we shouldn't run
{{{process_dollars}}} on this function. That is, change the first line of
{{{process_dollars}}} in conf.py from
{{{
if len(docstringlines) > 0:
}}}
to
{{{
if len(docstringlines) > 0 and name.find("process_dollars") == -1:
}}}
Similarly for {{{process_mathtt}}}. I've included this change in my
patch.
> Should we copy autodoc.py to SAGE_DOC/common/sage_autodoc.py, make all
of our changes in the latter, and add the custom extension in
SAGE_DOC/common/conf.py?
This is an interesting idea since we're patching it so much. Then it
would be under Sage revision control. We would just need to keep an eye
on it whenever we upgrade Sphinx. I'm posting a patch which adds it.
Actually, it doesn't add the whole thing, since I got an error when I
tried that. Instead, it does
{{{
from sphinx.ext.autodoc import *
}}}
and then it defines {{{FunctionDocumenter}}}, {{{MethodDocumenter}}},
{{{setup}}}, and {{{ClassDocumenter}}} (this one isn't patched right now,
but it looks like it will be in #7448).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8244#comment:12>
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.
