Opened 16 years ago
Closed 16 years ago
#9436 closed (fixed)
version[added|changed] directives should understand released versions and unreleased ones.
Reported by: | Marc Fargas | Owned by: | Jacob |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
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
Attachments (3)
Change History (6)
by , 16 years ago
comment:1 by , 16 years ago
Has patch: | set |
---|---|
Owner: | changed from | to
Status: | new → assigned |
Triage Stage: | Unreviewed → Ready for checkin |
Version: | 1.0 → SVN |
by , 16 years ago
Attachment: | 9436.2.diff added |
---|
Patch to support the version[added|changed] directive as talked on IRC.
comment:2 by , 16 years ago
Owner: | changed from | to
---|---|
Status: | assigned → new |
Summary: | New documentations patches are inconsistent with contributing.txt → 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.
comment:3 by , 16 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Fixes