|
|
17.
|
|
|
The third line must follow an empty line. This is the text that is displayed below the screenshot as figure description. In the PDF output, the descriptions will be numbered continuously.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:84
|
|
|
18.
|
|
|
If you want to include an image inline with the text and don't want to or can't use the regular figure, you should create a substitution and place it into the shortcuts.rstext file.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:47
|
|
|
19.
|
|
|
Admonitions in use are
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:100
|
|
|
20.
|
|
|
**note**: for anything that should receive a bit more attention
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:102
|
|
|
21.
|
|
|
Notes can be placed directly within a bulleted list. As usual, an empty line before and after the note must be placed and the admonition must be indented by 3 spaces.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:105
|
|
|
22.
|
|
|
**warning**: for anything that needs to be done with caution
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:107
|
|
|
23.
|
|
|
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
|
|
|
24.
|
|
|
**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
|
|
|
25.
|
|
|
The `Sphinx user documentation <http://sphinx.pocoo.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 <http://groups.google.com/group/sphinx-dev/>`_.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:117
|
|
|
26.
|
|
|
**todo**: for keeping a running ToDo list
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:67
|
