sphinx-doc / sphinx-doc/sphinx

Built-in extension: informing about translation progress

Open
#11,537 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extensions good first issue internals:internationalisation type:enhancement
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Sphinx's Gettext internationalization documentation and the related issue #11157 and pull requests #11502 and #11509. Determine how a built-in extension should detect an incompletely translated article and expose the note behavior requested here. Done means an accepted design and implementation that informs readers at the top of every article whose translation is incomplete.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, internationalization, localization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.