Context Navigation

← Previous Ticket
Next Ticket →

#12678 closed enhancement (fixed)

Extract a method to get the name of the .rst file corresponding to a python module, and doctest it.

Reported by:	nthiery	Owned by:	mvngu
Priority:	major	Milestone:	sage-5.0
Component:	documentation	Keywords:
Cc:		Merged in:	sage-5.0.beta10
Authors:	Nicolas M. Thiéry	Reviewers:	Mike Hansen
Report Upstream:	N/A	Work issues:
Branch:		Commit:
Dependencies:		Stopgaps:

Status badges

Description (last modified by nthiery)

Title says it all.

I thought I needed this method, and finally did not. I put it here in case this could be useful to someone else. Feel free to review and get merged if you want to add a doctested method to Sage :-)

Attachments (1)

trac_12678-doc-auto_rest_filename-nt.patch (1.5 KB) - added by nthiery 10 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 10 years ago by nthiery

Description modified (diff)
Status changed from new to needs_review

comment:2 Changed 10 years ago by mhansen

Reviewers set to Mike Hansen
Status changed from needs_review to positive_review

Looks good to me.

comment:3 follow-up: ↓ 4 Changed 10 years ago by jdemeyer

Status changed from positive_review to needs_work

Not everybody installs Sage in /opt/sage-5.0.beta8:

sage -t  -force_lib devel/sage/doc/common/builder.py
**********************************************************************
File "/scratch/jdemeyer/merger/sage-5.0.beta10/devel/sage-main/doc/common/builder.py", line 606:
    sage: builder.ReferenceBuilder("reference").auto_rest_filename("sage.combinat.partition")
Expected:
    '/opt/sage-5.0.beta8/devel/sage/doc/en/reference/sage/combinat/partition.rst'
Got:
    '/scratch/jdemeyer/merger/sage-5.0.beta10/devel/sage/doc/en/reference/sage/combinat/partition.rst'
**********************************************************************