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

Closes #1651: Documentation: add `vartype` field description for python domain.

Browse Source
This commit is contained in:
shimizukawa
2015-03-09 22:51:20 +09:00
parent 65fb5a664d
commit 25251a3d53
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGES
View File

@@ -39,6 +39,10 @@ Bugs fixed
:rst:dir:`literalinclude` dirctives. :rst:dir:`literalinclude` dirctives.
* #1756: Incorrect section titles in search that was introduced from 1.3b3. * #1756: Incorrect section titles in search that was introduced from 1.3b3.
Documentation
-------------
* #1651: Add ``vartype`` field descritpion for python domain.
Release 1.3b3 (released Feb 24, 2015) Release 1.3b3 (released Feb 24, 2015)
===================================== =====================================

1
doc/domains.rst
View File

@@ -314,6 +314,7 @@ are recognized and formatted nicely:
* ``raises``, ``raise``, ``except``, ``exception``: That (and when) a specific * ``raises``, ``raise``, ``except``, ``exception``: That (and when) a specific
exception is raised. exception is raised.
* ``var``, ``ivar``, ``cvar``: Description of a variable. * ``var``, ``ivar``, ``cvar``: Description of a variable.
* ``vartype``: Type of a variable. Creates a link if possible.
* ``returns``, ``return``: Description of the return value. * ``returns``, ``return``: Description of the return value.
* ``rtype``: Return type. Creates a link if possible. * ``rtype``: Return type. Creates a link if possible.