Opened 9 years ago

Closed 6 years ago

#13063 closed defect (fixed)

Doctesting rst files

Reported by: roed Owned by: roed
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: doctest framework Keywords:
Cc: kini Merged in:
Authors: Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: #12415 Stopgaps:

Description

Currently we parse rst files in the documentation in exactly the same way as we parse python files: search for triple quoted strings and then search for sage: within them. This is the wrong approach within an rst file, since doctests can occur within normal text. Instead, we should use docutils to parse the rst files and look for verbatim or doctest blocks, and then search within those.

Change History (9)

comment:1 Changed 9 years ago by roed

  • Cc kini added

comment:2 Changed 8 years ago by roed

  • Component changed from doctest to doctest framework
  • Owner changed from mvngu to roed

comment:3 Changed 7 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:4 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:5 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:6 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:7 in reply to: ↑ description Changed 6 years ago by jdemeyer

  • Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
  • Reviewers set to Jeroen Demeyer
  • Status changed from new to needs_review

Replying to roed:

Currently we parse rst files in the documentation in exactly the same way as we parse python files: search for triple quoted strings and then search for sage: within them.

This is simply not true anymore, all files in src/doc/[a-z][a-z] are tested.

comment:8 Changed 6 years ago by jdemeyer

  • Status changed from needs_review to positive_review

comment:9 Changed 6 years ago by vbraun

  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.