Make synopsis translatable

[eviau]

Thank you for building and maintaining Sphinx, it is a great project !

---

Is your feature request related to a problem? Please describe.

I have been part of the python-docs-fr localization project.

I wanted to translate the pymodule index page: https://docs.python.org/fr/3/py-modindex.html

As far as I understand, this page is generated automatically by Sphinx. The synopsis are not available in any .po file.

How to make them available for translation?

I believe that having this page accessible in the same locales as the docs is pivotal in navigating the docs in the chosen locale.

Describe the solution you'd like

I would like to have access to the synopsis on this page, either in one associated po file, or in the respective modules po files.

Describe alternatives you've considered

I did try to discover how to make the changes by myself, but my understanding of the Sphinx project does not enable me to make the changes, in either a PR to the main branch of the project, or as a sphinx extension, or a sphinxcontrib package.

As far as my understanding goes, the changes needs to be made in Sphinx itself, not in sphinx-intl nor docutils.

Additional context

This question was part of python/python-docs-fr#1705

I would be happy to work towards a solution for this feature with someone else in a pair programming setting, or to have some sort of support/mentoring to do so.

[eviau]

My current main insight that might work would be to implement the translatable class:

sphinx/sphinx/addnodes.py

Line 47 in 56f97d7

class translatable(nodes.Node):

in the index class:

sphinx/sphinx/addnodes.py

Line 378 in 56f97d7

class index(nodes.Invisible, nodes.Inline, nodes.TextElement):

Does that make any sense ?

[eviau]

I have also looked at #7979 and #2880 for getting a better understanding of how to do this.

[eviau]

It's been a while - wanted to note that there are some good hints in #11956 (comment)

I believe that the synopsis is already a node, but I might be wrong...

Would it be possible to add a help wanted label to this issue ?

[eviau]

I continued researching this issue.

I think this could be used: https://www.sphinx-doc.org/en/master/extdev/i18n.html

My question is: is this only meant for extensions, or is this meant to be used in general?

Would someone know?