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: sage-5.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:

Status badges

Description (last modified by Florent Hivert)

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 sage-5.0.beta8.

We should add a regression test on that kinds of problem.

Apply:

Change History (15)

comment:1 Changed 11 years ago by Florent Hivert

Owner: changed from Minh Van Nguyen to mvngu, hivert

Changed 11 years ago by Jeroen Demeyer

Attachment: 12849_doctest.patch added

Doctest for the issue

comment:2 Changed 11 years ago by Jeroen Demeyer

I created a doctest for this issue, which obviously fails on recent Sage betas.

comment:3 in reply to:  2 ; Changed 11 years ago by Florent 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.

comment:4 Changed 11 years ago by Jeroen Demeyer

sage-5.0.beta5 is still okay.

comment:5 in reply to:  3 Changed 11 years ago by Jeroen Demeyer

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 Jeroen Demeyer

Description: modified (diff)

comment:7 Changed 11 years ago by Florent Hivert

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 Jeroen Demeyer

Description: modified (diff)

It looks like this was introduced in sage-5.0.beta8.

comment:9 Changed 11 years ago by Jeroen Demeyer

The culprit is #9128.

comment:10 in reply to:  9 Changed 11 years ago by Florent Hivert

Thanks for investigating.

Replying to jdemeyer:

The culprit is #9128.

Strange ! It was an obvious candidate and I'm pretty sure I started by checking this one. Still I don't understand what could cause that in #9128. I'm testing my fix.

Florent

comment:11 Changed 11 years ago by Jeroen Demeyer

Priority: blockercritical

comment:12 Changed 11 years ago by Florent Hivert

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 
    576576    newnode.append(contnode)
    577577    return newnode
    578578
     579from sage.misc.sageinspect import sage_getargspec
     580autodoc_builtin_argspec = sage_getargspec
    579581
    580582def setup(app):
    581583    app.connect('autodoc-process-docstring', process_docstring_cython)

Changed 11 years ago by Florent Hivert

comment:13 Changed 11 years ago by Florent Hivert

Authors: Florent Hivert, Jeroen Demeyer
Description: modified (diff)
Status: newneeds_review
Note: See TracTickets for help on using tickets.