#6664: [with patch, positive review] Update autodoc-skip-member for Sphinx
v0.6.x
---------------------------+------------------------------------------------
Reporter: mpatel | Owner: tba
Type: defect | Status: new
Priority: minor | Milestone: sage-4.1.2
Component: documentation | Keywords:
Reviewer: John Palmieri | Author: Mitesh Patel
Merged: |
---------------------------+------------------------------------------------
Changes (by newvalueoldvalue):
* reviewer: => John Palmieri
* milestone: => sage-4.1.2
* author: => Mitesh Patel
Comment:
I think that having different versions of the reference manual was
discussed at some point, but without definite outcomes or guidelines.
Maybe it should be discussed on sage-devel?
At the moment, though, including private methods is a bit problematic.
First, {{{__weakref__}}} appears sort of at random, and then some classes
get all sorts of weird extra methods, maybe inherited from another class?
See the {{{Matrix}}} class in
{{{SAGE_ROOT/devel/sage/doc/output/html/en/reference/sage/matrix/matrix0.html}}},
for example; there is an entry for {{{__delitem__}}}, and the entry for
{{{__init__}}} is wrong: it looks generic rather than the one which is
actually in the file. Maybe this has to do with it being Cython rather
than Python.
Is it better to exclude all private methods, or to include them at the
price of having all sorts of extra crap in addition? I say we continue to
exclude them until we can figure out how to fix this. So let's keep this
patch for now. I'll give it a positive review.
Does this really depend on #6586, or can it be merged now?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6664#comment:4>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---