Allow internationalization of 'conf.py' · sphinx-doc/sphinx#1260

(3 评论) (16 反应) (0 负责人)Python (5,625 star) (1,985 fork)batch import

help wantedinternals:internationalisationtype:enhancement

描述

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?

Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/1260
Originally reported by: fero14041
Originally created at: 2013-09-09T13:49:19.868

贡献者指南

技术栈: python
领域: documentationinternationalizationlocalization
议题类型: feature
难度: 3
预计时间: 3-5 days
活动状态: stale
清晰度: mostly clear
前置要求: Understanding of Sphinx's gettext builderBasic Python
新手友好度: 40
研究方向: Investigate how Sphinx's gettext builder currently extracts translatable strings from reStructuredText files (likely in sphinx/builders/gettext.py). Determine how to add support for scanning conf.py for strings wrapped in () and generate a dedicated POT file. Check existing tests and documentation for gettext builder to understand the expected output format. Also explore how conf.py is imported and executed to safely extract strings without side effects.