Sphinx AutoSectionLabel Extension Setting

49 views
Skip to first unread message

Abhijeet Viswa

unread,
Dec 26, 2019, 5:06:28 AM12/26/19
to django-d...@googlegroups.com
Hey,

Ticket #28290 has been lying in the easy pickings for too long now. I don't believe a patch has been submitted.

It was suggested in n the issue raised by the reporter, Tony Narlock, on the Sphinx project, to use the AutoSectionLabel extension to automatically label sections, and hence solve the issue.

A label with the same name as the section is generated automatically. If the section name is repeated anywhere else in the whole document, one of the possiblities is chosen as the default. (Ref: https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html) There exists an setting autosectionlabel_prefix_document that appends the name of the document the section is in.

I'm personally more inclined to appending the document name. However, I'd like to get the opinion of the community before proceeding. Whatever option be chosen, it would have to be documented in the documentation itself.

Thanks,
Abhijeet

Abhijeet Viswa

unread,
Dec 26, 2019, 5:52:38 AM12/26/19
to django-d...@googlegroups.com
Here is my patch with the aforementioned setting set to true: https://github.com/django/django/pull/12251
--
Abhijeet
Reply all
Reply to author
Forward
0 new messages