Code

Opened 5 years ago

Closed 5 years ago

#9436 closed (fixed)

version[added|changed] directives should understand released versions and unreleased ones.

Reported by: telenieko Owned by: jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

There are some ".. versionadded:: development" strings in trunk's documentation.

According to contributing.txt (1) and somehow to a relevant thread(2) those should read: .. versionadded:: 1.1

1: contributing.txt
2: a revelant thread

Attachments (3)

9436.diff (1.4 KB) - added by telenieko 5 years ago.
Fixes
9436.2.diff (3.9 KB) - added by telenieko 5 years ago.
Patch to support the version[added|changed] directive as talked on IRC.
9436.3.diff (3.9 KB) - added by telenieko 5 years ago.
Good day to update patches ;)

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by telenieko

Fixes

comment:1 Changed 5 years ago by telenieko

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to telenieko
  • Patch needs improvement unset
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Ready for checkin
  • Version changed from 1.0 to SVN

Changed 5 years ago by telenieko

Patch to support the version[added|changed] directive as talked on IRC.

comment:2 Changed 5 years ago by telenieko

  • Owner changed from telenieko to jacob
  • Status changed from assigned to new
  • Summary changed from New documentations patches are inconsistent with contributing.txt to version[added|changed] directives should understand released versions and unreleased ones.

Attached a patch modifiyng Sphinx behaviour as talked on IRC with Jacob, in brief:

A new config value is added to conf.py called "django_next_version" to tell Sphinx which is the next version we will release.

With this in place, when a version[added|changed] directive has the number of django_next_version it will be replaced by a "Development Version" note, otherwise, two things can happen:

  • If the directive has an explanation paragraph it is left *as-is*.
  • If there's no additional paragraph a Link to the corresponding release notes is placed on the "Changed/NEw in ...." note.

That allows to remove the informational paragraphs after release removing the clutter on the docs after release.

Changed 5 years ago by telenieko

Good day to update patches ;)

comment:3 Changed 5 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

(In [10006]) Fixed #9436 -- Updated docs build code to create "new in development version".
Patch from Marc Fargas.

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.