Opened 14 years ago
Closed 13 years ago
#14836 closed Bug (fixed)
Improve semantics of docs:
| Reported by: | Greg Turner | Owned by: | Greg Turner |
|---|---|---|---|
| Component: | *.djangoproject.com | 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 |
Description
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 http://groups.google.com/group/django-developers/browse_thread/thread/2d14c16358069b37)
Change History (5)
comment:1 by , 14 years ago
| Component: | Documentation → Django Web site |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 14 years ago
| Severity: | → Normal |
|---|---|
| Type: | → Bug |
comment:5 by , 13 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
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-titleis 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.
FWIW, these are all more about the django website than the documentation, so I'm re-categorizing.