#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.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/01070199f791f291-39023fdf-01f3-4404-bc47-c557029b67c4-000000%40eu-central-1.amazonses.com.
