Opened 7 years ago

Closed 7 years ago

#27916 closed Bug (fixed)

versionchanged / versionadded annotation titles missing in downloadable docs

Reported by: Ulrich Petri Owned by: nobody
Component: Documentation Version: 1.10
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The downloadable docs don't contain the titles for the versionchanged / versionadded annotations. The html source contains the respective divs with optional content but the "New in Django ..." and "Changed in Django ..." title spans are missing.

Example from the html version (ref/settings.html#engine):

Online version:

<div class="versionchanged">
    <span class="title">Changed in Django 1.9:</span> 
    <p>The <code class="docutils literal"><span class="pre">django.db.backends.postgresql</span></code> backend is named <code class="docutils literal"><span class="pre">django.db.backends.postgresql_psycopg2</span></code> in older releases. For backwards compatibility, the old name still works in newer versions.</p>
</div>

Downloadable version:

<div class="versionchanged">
    <p>The <code class="docutils literal"><span class="pre">django.db.backends.postgresql</span></code> backend is named <code class="docutils literal"><span class="pre">django.db.backends.postgresql_psycopg2</span></code> in older releases. For backwards compatibility, the old name still works in newer versions.</p>
</div>

Change History (4)

comment:1 by Tim Graham, 7 years ago

Triage Stage: UnreviewedAccepted

To clarify, the "downloadable docs" are at https://docs.djangoproject.com/m/docs/django-docs-dev-en.zip.

The script to build them is at https://github.com/django/djangoproject.com/blob/master/docs/management/commands/update_docs.py. I'm not sure if the problem is in that script or somewhere else.

comment:3 by Ulrich Petri, 7 years ago

Has patch: set

comment:4 by Tim Graham, 7 years ago

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.
Back to Top