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

Fix :term:title <target>, and make giving multiple cmdoptions possible.

Browse Source
This commit is contained in:
Georg Brandl
2008-04-07 05:19:26 +00:00
parent 61b697514c
commit 11f63acd22
4 changed files with 36 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/markup/desc.rst
View File

@@ -175,15 +175,19 @@ The directives are:
Describes a Python bytecode instruction (this is not very useful for projects
other than Python itself).
.. directive:: .. cmdoption:: name args
.. directive:: .. cmdoption:: name args, name args, ...
Describes a command line option or switch. Option argument names should be
enclosed in angle brackets. Example::
.. cmdoption:: -m <module>
.. cmdoption:: -m <module>, --module <module>
Run a module as a script.
The directive will create a cross-reference target named after the *first*
option, referencable by :role:`option` (in the example case, you'd use
something like ``:option:`-m```).
.. directive:: .. envvar:: name
Describes an environment variable that the documented code uses or defines.