Create a role :trac: to link to trac ticket in sphinx

[hivert]

In the doc, putting :trac:`5534` adds a link to #5534.

I think its cool and useful.

I also add a :wikipedia: role.

Florent

CC: @kini @nathanncohen @novoselt

Component: doctest coverage

Keywords: Sphinx trac link Cernay2012

Author: Florent Hivert

Reviewer: Nathann Cohen, Jeroen Demeyer

Merged: sage-5.0.beta4

Issue created by migration from https://trac.sagemath.org/ticket/12490

[hivert]

Changed keywords from Sphinx trac link to Sphinx trac link Cernay2012

[nathanncohen]

Reviewer: Nathann Cohen

[nathanncohen]

comment:4

Looks good ! Now we must remember to use this new syntax in the patches :-)

Perhaps it is worth sending a message to sage-devel to tell everybody about it ?

Nathann

[hivert]

comment:5

I forgot to add a log message in the header of the patch. I just uploaded a new patch which just add one. I don't think this need a re-review.

[jdemeyer]

comment:6

Please write a proper commit message for your patch, use hg qrefresh -e for this.

[hivert]

comment:7

Replying to @jdemeyer:

Please write a proper commit message for your patch, use hg qrefresh -e for this.

That's precisely why I uploaded a new patch 1 hour ago. Is there any problem with my message ?

[jdemeyer]

comment:8

Excellent! There was a race condition between me checking patches and you uploading a new patch.

[jdemeyer]

comment:9

If you copy a doctest, you should copy it completely:

sage -t  "devel/sage/doc/en/developer/sage_manuals.rst"
**********************************************************************
File "/usr/local/src/sage-5.0.beta1/devel/sage/doc/en/developer/sage_manuals.rst", line 165:
    sage: x = sage.combinat.subword.smallest_positions(w, ww); ww
Exception raised:
    Traceback (most recent call last):
      File "/usr/local/src/sage-5.0.beta1/local/bin/ncadoctest.py", line 1231, in run_one_test
        self.run_one_example(test, example, filename, compileflags)
      File "/usr/local/src/sage-5.0.beta1/local/bin/sagedoctest.py", line 38, in run_one_example
        OrigDocTestRunner.run_one_example(self, test, example, filename, compileflags)
      File "/usr/local/src/sage-5.0.beta1/local/bin/ncadoctest.py", line 1172, in run_one_example
        compileflags, 1) in test.globs
      File "<doctest __main__.example_0[2]>", line 1, in <module>
        x = sage.combinat.subword.smallest_positions(w, ww); ww###line 165:
    sage: x = sage.combinat.subword.smallest_positions(w, ww); ww
    NameError: name 'w' is not defined
**********************************************************************

[hivert]

comment:10

Replying to @jdemeyer:

If you copy a doctest, you should copy it completely:

Oups ! We forgot to run the test of the doc too ! Sorry !

The test was extracted from sage/combinat/subword.py. I extracted it in full.

[hivert]

comment:11

Attachment: trac_12490-trac_role-fh.patch.gz

Here is the corrected patch. Can I put it back myself to positive review ?

[jdemeyer]

Changed reviewer from Nathann Cohen to Nathann Cohen, Jeroen Demeyer

[nathanncohen]

comment:14

I was just about to do it !! Thank you :-)

Nathann

[jdemeyer]

Merged: sage-5.0.beta4