sphinx-doc/sphinx

gettext_additional_targets not identifying custom directive

Open

#11,956 opened on Feb 6, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
help wantedtype:proposal

Description

Describe the bug

As per the documentation, gettext_additional_targets should allow you to specify additional targets for translation. But, it is not identifying directives like if-builder and panels.

How to Reproduce

I am using sphinx-panels extension: https://pypi.org/project/sphinx-panels/

index.rst:

Documentation
============

.. if-builder:: html

   .. panels::
      :container: container-lg pb-3
      :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2

      This is a test HTML line

conf.py

# -- Localization configuration
locale_dirs = ['locale/']   # path is example but recommended.
gettext_compact = False     # optional
gettext_additional_targets = ['literal-block', 'panels', 'if-builder']

On running the commands below:

make gettext
sphinx-intl update -p build/gettext -l ja

I don't see an entry in index.po for the line "This is a test HTML line"

index.po

#: ../../index.rst:2
msgid "Documentation"
msgstr ""

Expected output:

index.po

#: ../../index.rst:2
msgid "Documentation"
msgstr ""

#: ../../index.rst:5
msgid "This is a test HTML line"
msgstr ""

Environment Information

Platform:              linux; (Linux-5.15.0-92-generic-x86_64-with-glibc2.29)
Python version:        3.8.10 (default, Nov 22 2023, 10:22:35) 
[GCC 9.4.0])
Python implementation: CPython
Sphinx version:        6.2.1
Docutils version:      0.18.1
Jinja2 version:        3.1.2
Pygments version:      2.15.1

Sphinx extensions

extensions = [
    'sphinxcontrib.httpdomain',
    'sphinxcontrib.httpexample',
    'sphinx.ext.doctest',
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.autosectionlabel',
    'linuxdoc.rstFlatTable',
    'sphinx_design',
    'sphinx_panels'
]

Additional context

No response

Contributor guide

Tech stack
python
Domain
documentationbackend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Sphinx extensionsKnowledge of gettext/i18n
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the handling of gettext additional targets in Sphinx's gettext builder, likely in sphinx/builders/gettext.py. Check how custom directives like if builder and panels are registered and whether they are included in the translation extraction. Look for any logic that filters directives based on a known list. Also verify the sphinx panels extension's directive registration. Consider testing with a minimal example to confirm the bug.