[Django] #27916: versionchanged / versionadded annotation titles missing in downloadable docs

39 views
Skip to first unread message

Django

unread,
Mar 8, 2017, 2:17:13 PM3/8/17
to django-...@googlegroups.com
#27916: versionchanged / versionadded annotation titles missing in downloadable
docs
-----------------------------------------+------------------------
Reporter: Ulrich Petri | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
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>
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/27916>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Mar 8, 2017, 8:16:41 PM3/8/17
to django-...@googlegroups.com
#27916: versionchanged / versionadded annotation titles missing in downloadable
docs
-------------------------------+------------------------------------

Reporter: Ulrich Petri | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by Tim Graham):

* stage: Unreviewed => Accepted


Comment:

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.

--
Ticket URL: <https://code.djangoproject.com/ticket/27916#comment:1>

Django

unread,
Apr 6, 2017, 8:23:10 AM4/6/17
to django-...@googlegroups.com
#27916: versionchanged / versionadded annotation titles missing in downloadable
docs
-------------------------------+------------------------------------

Reporter: Ulrich Petri | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------

Comment (by Ulrich Petri):

Fixed in PR: https://github.com/django/djangoproject.com/pull/758

--
Ticket URL: <https://code.djangoproject.com/ticket/27916#comment:2>

Django

unread,
Apr 6, 2017, 8:30:34 AM4/6/17
to django-...@googlegroups.com
#27916: versionchanged / versionadded annotation titles missing in downloadable
docs
-------------------------------+------------------------------------

Reporter: Ulrich Petri | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by Ulrich Petri):

* has_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/27916#comment:3>

Django

unread,
Apr 6, 2017, 10:28:59 AM4/6/17
to django-...@googlegroups.com
#27916: versionchanged / versionadded annotation titles missing in downloadable
docs
-------------------------------+------------------------------------

Reporter: Ulrich Petri | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 1.10
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by Tim Graham):

* status: new => closed
* resolution: => fixed


--
Ticket URL: <https://code.djangoproject.com/ticket/27916#comment:4>

Reply all
Reply to author
Forward
0 new messages