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

Merge pull request #1967 from eolo999/master

Browse Source 
Document ``cmdoption`` directive deprecation
This commit is contained in:
Georg Brandl 2015-07-25 13:04:04 +02:00
commit f53fb63627
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/domains.rst
View File

@ -696,6 +696,8 @@ There is a set of directives allowing documenting command-line programs:
referencable by :rst:role:`option` (in the example case, you'd use something referencable by :rst:role:`option` (in the example case, you'd use something
like ``:option:`dest_dir```, ``:option:`-m```, or ``:option:`--module```). like ``:option:`dest_dir```, ``:option:`-m```, or ``:option:`--module```).
``cmdoption`` directive is a deprecated alias for the ``option`` directive.
.. rst:directive:: .. envvar:: name .. rst:directive:: .. envvar:: name
Describes an environment variable that the documented code or program uses or Describes an environment variable that the documented code or program uses or