odoo
/
odoo
2
0
Fork 0
Code Pull Requests Releases Activity

[IMP] Sphinx will automatically cross-reference return types it understands, for direct class references no need to manually cross-ref 

bzr revid: xmo@openerp.com-20110327135900-wqk5ow1m4zavnwvg
This commit is contained in:
Xavier Morel 2011-03-27 15:59:00 +02:00
parent 8b485e7b52
commit 91d620c328
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/project.rst
View File

@ -51,14 +51,14 @@ RST, using Sphinx's `Python domain`_ [#]_:
unless a more extensive explanation needs to be given (e.g. the
specification that the input should be a list of 3-tuple needs to
use ``:type:`` even though all types involved are built-ins). Any
other type should be specified in full with a cross-reference using
the ``:type:`` field::
other type should be specified in full using the ``:type:`` field::
:param foo: what the purpose of foo is
:type foo: :class:`some.addon.Class`
:type foo: some.addon.Class
Likewise, mentions of other methods (including within the same
class), modules or types should be cross-referenced.
Mentions of other methods (including within the same class), modules
or types in descriptions (of anything, including parameters) should
be cross-referenced.
* Classes should likewise be documented using their own docstring, and
should include the documentation of their construction (``__init__``