[Django] #36672: Django documentation objects.inv issue

7 views
Skip to first unread message

Django

unread,
Oct 18, 2025, 9:46:07 AM10/18/25
to django-...@googlegroups.com
#36672: Django documentation objects.inv issue
------------------------+-----------------------------------------
Reporter: minusf | Type: Bug
Status: new | Component: Documentation
Version: 5.2 | Severity: Normal
Keywords: sphinx | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
------------------------+-----------------------------------------
While using the offline documentation tool Dash, I have noticed that
certain pages are missing certain ToC items while the webpages have no
such issues.

I reached out to the author of Dash who has confirmed that the ToC is
generated from django's own `objects.inv` file.

Please see the attached screenshots for Dash's ToC and the websites ToC
for the same page "How to create custom template tags and filters".

I am not very familiar with sphinx but I did a `make html` locally and it
seems that is missing certain Header elements from `objects.inv`:

"Code layout" is present in both:
{{{
% grep 'Code layout' uncompressed-objects.inv
howto/custom-template-tags:code layout std:label -1 howto/custom-template-
tags.html#code-layout Code layout
}}}

"Simple tags" is present in both:
{{{
% grep 'Simple tags' uncompressed-objects.inv
howto-custom-template-tags-simple-tags std:label -1 howto/custom-template-
tags.html#$ Simple tags
}}}

"Registering custom filters" only in html docs and missing from Dash:
{{{
grep 'Registering custom filters' uncompressed-objects.inv

}}}

"Registering the tag" only in html and missing from Dash:
{{{
grep 'Registering the tag' uncompressed-objects.inv
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36672>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Oct 18, 2025, 9:46:26 AM10/18/25
to django-...@googlegroups.com
#36672: Django documentation objects.inv issue
-------------------------------+--------------------------------------
Reporter: minusf | Owner: (none)
Type: Bug | Status: new
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: sphinx | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by minusf):

* Attachment "Screenshot 2025-10-18 at 15.38.11.png" added.

Django

unread,
Oct 18, 2025, 9:46:29 AM10/18/25
to django-...@googlegroups.com
#36672: Django documentation objects.inv issue
-------------------------------+--------------------------------------
Reporter: minusf | Owner: (none)
Type: Bug | Status: new
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: sphinx | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by minusf):

* Attachment "Screenshot 2025-10-18 at 15.38.11.png" removed.

Django

unread,
Oct 18, 2025, 9:47:16 AM10/18/25
to django-...@googlegroups.com
#36672: Django documentation objects.inv issue
-------------------------------+--------------------------------------
Reporter: minusf | Owner: (none)
Type: Bug | Status: new
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: sphinx | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by minusf):

* Attachment "django-html-docs.png" added.

Django

unread,
Oct 18, 2025, 9:47:20 AM10/18/25
to django-...@googlegroups.com
#36672: Django documentation objects.inv issue
-------------------------------+--------------------------------------
Reporter: minusf | Owner: (none)
Type: Bug | Status: new
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: sphinx | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by minusf):

* Attachment "dash-django-docs.png" added.
Reply all
Reply to author
Forward
0 new messages