Opened 11 years ago
Last modified 10 years ago
#12849 closed defect
The argspecs of extension function/methods is broken in the Sphinx documentation — at Version 13
Reported by:  Florent Hivert  Owned by:  mvngu, hivert 

Priority:  critical  Milestone:  sage5.0 
Component:  documentation  Keywords:  argspecs Cython 
Cc:  Merged in:  
Authors:  Florent Hivert, Jeroen Demeyer  Reviewers:  
Report Upstream:  N/A  Work issues:  
Branch:  Commit:  
Dependencies:  Stopgaps: 
Description (last modified by )
In the current Sphinx HTML doc, the extenstion function and methods have no arguments setup.
See for example the documentation of
reference/sage/symbolic/expression.html#sage.symbolic.expression.Expression.N
which was ok (see there) in Sage 4.8. The problem was introduced in sage5.0.beta8.
We should add a regression test on that kinds of problem.
Apply
:
Change History (15)
comment:1 Changed 11 years ago by
Owner:  changed from Minh Van Nguyen to mvngu, hivert 

Changed 11 years ago by
Attachment:  12849_doctest.patch added 

comment:2 followup: 3 Changed 11 years ago by
I created a doctest for this issue, which obviously fails on recent Sage betas.
comment:3 followup: 5 Changed 11 years ago by
Replying to jdemeyer:
I created a doctest for this issue, which obviously fails on recent Sage betas.
Thanks ! I tried to figureout a way to call directly Sphinx but this is much easier. I'll try to work on this this afternoon. Do you have somewhere the various beta compiled so that I can rsync them on boxen to help bissecting ? So far the few guesses I made to find the culprit were wrong.
comment:5 Changed 11 years ago by
Replying to hivert:
Replying to jdemeyer:
I created a doctest for this issue, which obviously fails on recent Sage betas.
Thanks ! I tried to figureout a way to call directly Sphinx but this is much easier. I'll try to work on this this afternoon. Do you have somewhere the various beta compiled so that I can rsync them on boxen to help bissecting ? So far the few guesses I made to find the culprit were wrong.
Look at http://boxen.math.washington.edu/home/release/. There should be binaries for all Sage betas, made on sage.math or boxen.math.
comment:6 Changed 11 years ago by
Description:  modified (diff) 

comment:7 Changed 11 years ago by
It seems that I have a fix, but I don't understand how it worked before ! Still looking.
Florent
comment:8 Changed 11 years ago by
Description:  modified (diff) 

It looks like this was introduced in sage5.0.beta8.
comment:10 Changed 11 years ago by
comment:11 Changed 11 years ago by
Priority:  blocker → critical 

comment:12 Changed 11 years ago by
Hi,
I got the fix ! I'm definitely the culprit. For strange reason the following lines were removed by #9128. Putting them back should fix the problem.

doc/common/conf.py
diff git a/doc/common/conf.py b/doc/common/conf.py
a b def find_sage_dangling_links(app, env, n 576 576 newnode.append(contnode) 577 577 return newnode 578 578 579 from sage.misc.sageinspect import sage_getargspec 580 autodoc_builtin_argspec = sage_getargspec 579 581 580 582 def setup(app): 581 583 app.connect('autodocprocessdocstring', process_docstring_cython)
Changed 11 years ago by
Attachment:  trac_12849extfunc_argspec_html_fixfh.patch added 

comment:13 Changed 11 years ago by
Authors:  → Florent Hivert, Jeroen Demeyer 

Description:  modified (diff) 
Status:  new → needs_review 
Doctest for the issue