Opened 7 years ago

Closed 5 years ago

#11817 closed Bug (worksforme)

Incorrect document structures in django-documentation

Reported by: Axel Rau Owned by: nobody
Component: contrib.admindocs Version: 1.1
Severity: Normal Keywords:
Cc: josh@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


Some templates of the django documentation respectively the contents contain incorrect document structures - e.g.

Template tag documentation

<h4><p>Force autoescape behaviour for this block.</p></h4>

The h4 should not contain a p

The single p after the h4 should be removed

Change History (8)

comment:1 Changed 7 years ago by joshuajonah

Cc: josh@… added
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset

If you have time, can you link the the problem pages?

comment:2 Changed 7 years ago by Kellen

That line is from but I don't see the text anywhere in the normal documentation.

comment:3 Changed 7 years ago by Tim Graham

Component: DocumentationContrib apps

This is actually from "Template tag documentation" page (/admin/doc/tags/) generated by the django.contrib.admindocs.

comment:4 Changed 7 years ago by Russell Keith-Magee

Triage Stage: UnreviewedAccepted

comment:5 Changed 6 years ago by Bas Peschier

With all the cleaning going on and new versions of docutils, this seems to have gone away? I cannot reproduce it anymore.

comment:6 Changed 6 years ago by Gabriel Hurley

Component: Contrib appsDocumentation

comment:7 Changed 5 years ago by Julien Phalip

Component: Documentationcontrib.admindocs
Easy pickings: unset
Severity: Normal
Type: Bug

comment:8 Changed 5 years ago by Aymeric Augustin

Resolution: worksforme
Status: newclosed
UI/UX: unset

I confirm this bug no longer exists.

Here's the current output corresponding to the bug report:

<h1>Template tag documentation</h1>

<div id="content-main">

<div class="module">
    <h2>Built-in tags</h2>
    <h3 id="built_in-autoescape">autoescape</h3>
    <h4>Force autoescape behavior for this block.
    <hr />
    <h3 id="built_in-block">block</h3>
    <h4>Define a block that can be overridden by child templates.
    <hr />
    <h3 id="built_in-comment">comment</h3>
    <h4>Ignores everything between {% comment %} and {% endcomment %}.
    <hr />

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