sphinx-doc/sphinx

Allow internationalization of 'conf.py'

Open

#1260 aperta il 3 gen 2015

Vedi su GitHub
 (3 commenti) (17 reazioni) (0 assegnatari)Python (1985 fork)batch import
help wantedinternals:internationalisationtype:enhancement

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

It could be usefull to add a new POT template for marked as translatable strings in 'conf.py' file.


Hi, Sphinx team.

At least in version 1.1.3, 'gettext' builder only creates POT templates for reStructuredText documents. But some configuration options, defined in 'conf.py', also need to be translated, in order to enhance translatability of all parts of a given documentation. For example, such a need occurs at least for:

  • 'extlinks' mapping from 'sphinx.ext.extlinks',
  • project's name or copyright,
  • date and time.

It should be possible to let mark all desirable strings with '_()', where choice could all fall at project's discretion. 'gettext' builder then could generate a dedicated POT file, letting translators add translations for these strings. (I'm not sure of last step, for generation of e.g. HTML built files, with such a modified 'conf.py'.)

What do you guys think about this idea, and then about its feasability?


Guida contributor