sphinx-doc/sphinx

Built-in extension: informing about translation progress

Open

#11.537 aberto em 30 de jul. de 2023

Ver no GitHub
 (1 comment) (5 reactions) (0 assignees)Python (1.985 forks)batch import
extensionsgood first issueinternals:internationalisationtype:enhancement

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)

Description

Is your feature request related to a problem? Please describe. Sphinx projects which are being translated into multiple languages using Gettext, when a translation is still in progress, display original paragraphs as a fallback to missing translations of paragraphs. That could be unexpected for a reader looking at a project in some language (which for example can be translated in a majority of content).

Describe the solution you'd like Built-in extension to enable displaying a note paragraph at the top of every article that is not fully translated, informing a reader about the progress of the translation in the article.

Would such an extension be accepted as a built-in?

Describe alternatives you've considered

  • third party extension – in my opinion the described functionality being accessible as batteries-included inside Sphinx would be beneficial to many projects around, as publishing the in progress translations seems to be a quite common case for projects using intl

Additional context

Guia do colaborador