Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Footnotes not rendering as expected in localized version #801

Open
thorge opened this issue Aug 17, 2023 · 3 comments · May be fixed by #931
Open

Footnotes not rendering as expected in localized version #801

thorge opened this issue Aug 17, 2023 · 3 comments · May be fixed by #931
Labels
bug Something isn't working

Comments

@thorge
Copy link

thorge commented Aug 17, 2023

What version of myst-parser are you using?

2.0.0

What version dependencies are you using?

sphinx-build (7.2.6)
sphinx-rtd-theme
sphinx-design
sphinxcontrib-mermaid
sphinxcontrib-svg2pdfconverter
sphinx-intl

What operating system are you using?

Linux

Describe the Bug

I have a Sphinx documentation using myst and sphinx-intl. In the default English version of the documentation, footnotes are formatted correctly, and I'm getting properly rendered footnotes in the resulting HTML when I build the documentation.

However, I've also created a localized German version of the documentation, and while the translation seems to work fine overall, I'm encountering an issue with footnotes. In the German version, the footnotes are not being converted to the correct HTML format. Instead of seeing the formatted footnotes as in the English version, it appears that the German version is simply printing the Markdown string, like [^1], without converting it to the expected HTML footnote markup. The footnote section works fine, but the inline link is not formatted and linked correctly.

/docs/source/test.md:1: WARNING: inconsistent footnote references in translated message. original: ['[^1]'], translated: []                                                                                                                   

test

The .po files look fine, e.g.:

#: ../test.md:1
msgid ""
"Test[^1]"
msgstr ""
"Test[^1]"

Expected Behavior

I expect that when I build the German version of the documentation, the footnotes should be processed and rendered in the same way as they are in the original English version. Other markdown features also work without interfering with the locales.

To Reproduce

No response

@thorge thorge added the bug Something isn't working label Aug 17, 2023
@welcome
Copy link

welcome bot commented Aug 17, 2023

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@j123b567
Copy link

Probably duplicate of #445

@chrisjsewell
Copy link
Member

Probably duplicate of #445

Doesn't matter, it's fixed in #931 anyway 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants