Opened 7 years ago

Closed 5 years ago

#14836 closed Bug (fixed)

Improve semantics of docs:

Reported by: Greg Turner Owned by: Greg Turner
Component: * Version: 1.2
Severity: Normal Keywords: sprintdec2010
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


Everything is mostly good, except:

  • #14835 and other things that can be fixed in the doc source file
  • 'This document describes Django 1.2. For development docs, go here.' is an <h2>. It should be a <p>.
  • This one came up when viewing the docs with site CSS turned off. Admonition titles are 'p.admonition-title'. I suggest including 'strong', rather than a heading, since it isn't context-free enough to be a heading (the HTML5 tag would be <aside>), but it needs to be higher up the chain than plain text.

I will patch these when we establish the way to update djangoproject's base.css file (discussion at

Change History (5)

comment:1 Changed 7 years ago by Gabriel Hurley

Component: DocumentationDjango Web site
Triage Stage: UnreviewedAccepted

FWIW, these are all more about the django website than the documentation, so I'm re-categorizing.

comment:2 Changed 6 years ago by James Addison

Severity: Normal
Type: Bug

comment:3 Changed 6 years ago by Aymeric Augustin

UI/UX: unset

Change UI/UX from NULL to False.

comment:4 Changed 6 years ago by Aymeric Augustin

Easy pickings: unset

Change Easy pickings from NULL to False.

comment:5 Changed 5 years ago by Aymeric Augustin

Resolution: fixed
Status: newclosed

AFAICT no patch was actually written, however:

  • #14835 was fixed.
  • the string 'This document describes Django 1.2. For development docs, go here.' apparently no longer exists on the website. At least I didn't find 'go here' in the source.
  • p.admonition-title is generated by Sphinx, and that's very hard to change.

Please re-open the ticket if I've missed something.

Note: See TracTickets for help on using tickets.
Back to Top