Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands

[CyberFox001]

Documentation

The Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.

But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.

The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.

In the @direntry command:

• The info file name, in parenthesis, should not include the .info extension [1]
• The menu entry description should be more descriptive than "One line description of project"

[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File

[StanFromIreland]

I cannot find how we generate it. I presume it is generated by texinfo? This would make modifying it a bit more complex.

[AA-Turner]

Happy to accept a PR. TexInfo is built by make -CDoc texinfo. This may require changes in Sphinx.

A

[hugovk]

Looks like we need to add something like this to conf.py (this example taken from Sphinx itself):

texinfo_documents = [
    (
        'index',
        'sphinx',
        'Sphinx Documentation',
        'the Sphinx developers',
        'Sphinx',
        'The Sphinx documentation builder.',
        'Documentation tools',
        True,
    ),
]

This value determines how to group the document tree into Texinfo source files. It must be a list of tuples (startdocname, targetname, title, author, dir_entry, description, category, toctree_only), where the items are: ...

https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-texinfo-output

[CyberFox001]

Happy to accept a PR. TexInfo is built by make -CDoc texinfo. This may require changes in Sphinx.

A

Would like to help, but I have no experience with Sphink and I only started to use Info manuals since yesterday.
It could take me a while to learn how to do it. Especially at this moment (school with exams).
But I could try.

[hugovk]

If you'd like to have a go, that'd be great! No rush, and just shout if you need a hand with anything or you'd like someone else to pick it up :)

And good luck with your exams!