|
|
62.
|
|
|
Try not to put everything into an admonition because then the truly important information is lost.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:110
|
|
|
63.
|
|
|
**seealso**: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:112
|
|
|
64.
|
|
|
The `Sphinx user documentation <http://www.sphinx-doc.org>`_ is a great place to deepend your knowledge and understanding of using rST with Sphinx. If you have any questions, you can also check out the `Sphinx discussion group <https://groups.google.com/forum/#!forum/sphinx-dev>`_.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:117
|
|
|
65.
|
|
|
**todo**: for keeping a running ToDo list. ToDo lists are currently disabled.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:117
|
|
|
66.
|
|
|
Conventions
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:120
|
|
|
67.
|
|
|
**Languages that do not use spaces between words**
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:123
|
|
|
68.
|
|
|
Sphinx assumes that there is always a space before a command starts and after one ends. That is the only way that it has to recognize the markup characters as ones that tell Sphinx what to do.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:125
|
|
|
69.
|
|
|
This poses a problem in languages such as Japanese as there are no spaces between words.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:127
|
|
|
70.
|
|
|
You do need to put spaces into the text though. Otherwise, formatting won't happen, index entries won't get created, and substitutions are not done. Thus, replicate the spacing that you see in the English version. For example, put a space:
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:129
|
|
|
71.
|
|
|
before and after a substitution such as ``|edit|``,
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:131
|
