Open JulianOrteil opened 2 years ago
For clarification, we believe the exact issue to be a lack of a space between :py:class:`~stepseries.responses.Busy`
and の別名です。
in the example image above.
I have the same problem, and it's just a space missing in the translation of alias of %s
, which is translated by %sの別名です
.
Instead, the translation should add a space (as it does elsewhere) to be %s の別名です
.
Short workaround for those who cannot wait:
Copy https://github.com/sphinx-doc/sphinx/blob/v5.3.0/sphinx/locale/ja/LC_MESSAGES/sphinx.po into your locale folder, with the sphing name, and replace %sの別名です
with %s の別名です
. The sphinx.mo in your locale folder will override the one in sphinx.
Describe the bug
In a project I'm working on, I have a requirement of translating the English documentation to Japanese. While working through the documentation, I was made aware that autodoc is not properly formatting some class members.
For example,
response_cls
in these images: English doc:Japanese translated doc:
The documentation for
response_cls
is automatically generated, we have not added any docstrings in the code or the .po files, as you can see:How to Reproduce
We use ReadTheDocs to automatically build our documentation. The issue can be seen here for the Japanese: https://python-step-series.readthedocs.io/ja/latest/python-step-series/api/stepseries.html#stepseries.commands.EnableBusyReport
I'm not sure how to view the translated docs locally, but here are the commands to build the English versions at least.
Expected behavior
The Japanese formatted class members to match their English counterparts.
Your project
https://github.com/ponoor/python-step-series.git
Screenshots
No response
OS
Ubuntu 20.04
Python version
3.9
Sphinx version
latest
Sphinx extensions
"sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.todo", "sphinx.ext.autosummary", "sphinx.ext.viewcode", "sphinx.ext.coverage", "sphinx.ext.doctest", "sphinx.ext.ifconfig", "sphinx.ext.mathjax", "sphinx.ext.napoleon"
Extra tools
Chrome or Edge, ReadTheDocs
Additional context
No response