diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-28 01:00:37 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-28 01:00:37 +0900 |
| commit | 223b1a94f2cd1d2af6297fa419ab96758ddd31e2 (patch) | |
| tree | fe18e6d06365e78a23eb3e18e3885e2175fe2e94 /doc/usage/advanced | |
| parent | 2db180da70cfd59ae53afab99d1eb7868fb7d206 (diff) | |
| parent | 4221d1a5163d023d80a34bd4a12e9c2a2c648ae3 (diff) | |
| download | sphinx-git-223b1a94f2cd1d2af6297fa419ab96758ddd31e2.tar.gz | |
Merge branch '4.x'
Diffstat (limited to 'doc/usage/advanced')
| -rw-r--r-- | doc/usage/advanced/intl.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/usage/advanced/intl.rst b/doc/usage/advanced/intl.rst index 3bf353e8d..ccdb6e982 100644 --- a/doc/usage/advanced/intl.rst +++ b/doc/usage/advanced/intl.rst @@ -68,6 +68,24 @@ be translated you need to follow these instructions: * Run your desired build. +In order to protect against mistakes, a warning is emitted if +cross-references in the translated paragraph do not match those from the +original. This can be turned off globally using the +:confval:`suppress_warnings` configuration variable. Alternatively, to +turn it off for one message only, end the message with ``#noqa`` like +this:: + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse + risus tortor, luctus id ultrices at. #noqa + +(Write ``\#noqa`` in case you want to have "#noqa" literally in the +text. This does not apply to code blocks, where ``#noqa`` is ignored +because code blocks do not contain references anyway.) + +.. versionadded:: 4.5 + The ``#noqa`` mechanism. + + Translating with sphinx-intl ---------------------------- |