IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove misguided recommendation to use emphasis for variables.

Browse Source
This commit is contained in:
Georg Brandl 2009-06-15 17:43:32 +02:00
parent 5e439cbbb5
commit 61a55f095b
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/markup/inline.rst
View File

@ -4,16 +4,13 @@ Inline markup
============= =============
Sphinx uses interpreted text roles to insert semantic markup into documents. Sphinx uses interpreted text roles to insert semantic markup into documents.
They are written as ``:rolename:`content```.
Variable names are an exception, they should be marked simply with ``*var*``.
For all other roles, you have to write ``:rolename:`content```.
.. note:: .. note::
The default role (```content```) has no special meaning by default. You are The default role (```content```) has no special meaning by default. You are
free to use it for anything you like; use the :confval:`default_role` config free to use it for anything you like, e.g. variable names; use the
value to set it to a known role. :confval:`default_role` config value to set it to a known role.
.. _xref-syntax: .. _xref-syntax: