Code

Opened 6 years ago

Closed 4 years ago

Last modified 3 years ago

#7474 closed (wontfix)

add documentation restructured text checker to test suite

Reported by: gwilson Owned by: kkubasik
Component: Testing framework Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Invalid restructured text in the documentation should be caught by the test suite and reported as errors. This would hopefully reduce the number of reST error tickets that seem to crop up pretty often.

Attachments (0)

Change History (5)

comment:1 Changed 6 years ago by telenieko

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Given that docs are being refactored I'm not sure if that should be 1.0 or post-1.0 unless such a test is fast to setup.
Note that it would also require docutils to be available on the buildbots.

But surely some kind of testing of docs/ should be done :)

comment:2 Changed 5 years ago by kkubasik

  • Owner changed from nobody to kkubasik

comment:3 Changed 4 years ago by ericholscher

  • milestone set to 1.3
  • Triage Stage changed from Accepted to Design decision needed

This seems like something that might work better as a Sphinx plugin. I know that sphinx will alert us if our documentation is broken or missing, so it seems like this might be invalid these days.

Going to make this 1.3 and a DDN, though I think it should be wontfix'd.

comment:4 Changed 4 years ago by russellm

  • Resolution set to wontfix
  • Status changed from new to closed
  • Triage Stage changed from Design decision needed to Accepted

I agree with Eric. A "make html" build already reports errors, so we already have a way of detecting "failures" -- we just need to run it.

On top of that, a clean "make html" build takes quite a while. This means it isn't ideal for a unittest, which generally relies of having lots of tests that are quick to run.

If we're going to do this, it really should be done as a step in a buildbot/CI build system, not as a test in the test suite.

comment:5 Changed 3 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.