Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
Trac
Trac
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 246
    • Issues 246
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Operations
    • Operations
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar

GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

  • Legacy
  • TracTrac
  • Issues
  • #10036

Closed
Open
Opened Oct 27, 2013 by Damian Johnson@atagar

Investigate using sphinx's doctest module

Presently we're using python's doctest module in our unit tests, which covers interpretor style examples (those with a '>>>'). However, this doesn't test examples using sphinx's '::' blocks, which we use for most of our examples.

Our unit tests provide test coverage for our tutorials, but they're maintained separately from the documentation itself so they often go stale if we update tutorials.

We should investigate using sphinx's doctest plugin or tricks with the python doctest module to get test coverage of the '::' sphinx blocks. This will likely require us to ask on the python list for ideas...

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: legacy/trac#10036