IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-13 06:24:46 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add an example.

Browse Source
This commit is contained in:
Georg Brandl
2010-05-24 13:05:43 +02:00
parent 0238e83013
commit 9d3e02d238
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/markup/inline.rst
+3 -1
View File
@@ -257,7 +257,9 @@ in a different style:
.. rst:role:: samp
A piece of literal text, such as code. Within the contents, you can use
curly braces to indicate a "variable" part, as in ``:file:``.
curly braces to indicate a "variable" part, as in :rst:dir:`file`. For
example, in ``:samp:`print 1+{variable}```, the part ``variable`` would be
emphasized.
If you don't need the "variable part" indication, use the standard
````code```` instead.