Opened 3 hours ago
#36672 new Bug
Django documentation objects.inv issue
Reported by: | minusf | Owned by: | |
---|---|---|---|
Component: | Documentation | Version: | 5.2 |
Severity: | Normal | Keywords: | sphinx |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
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
Attachments (2)
Change History (2)
by , 3 hours ago
Attachment: | django-html-docs.png added |
---|
by , 3 hours ago
Attachment: | dash-django-docs.png added |
---|