mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
111 lines
1.8 KiB
Plaintext
111 lines
1.8 KiB
Plaintext
Testing object descriptions
|
|
===========================
|
|
|
|
.. function:: func_without_module(a, b, *c[, d])
|
|
|
|
Does something.
|
|
|
|
.. function:: func_without_body()
|
|
|
|
.. function:: func_noindex
|
|
:noindex:
|
|
|
|
.. function:: func_with_module
|
|
:module: foolib
|
|
|
|
.. module:: mod
|
|
:synopsis: Module synopsis.
|
|
:platform: UNIX
|
|
|
|
.. function:: func_in_module
|
|
|
|
.. class:: Cls
|
|
|
|
.. method:: meth1
|
|
|
|
.. staticmethod:: meths
|
|
|
|
.. attribute:: attr
|
|
|
|
.. explicit class given
|
|
.. method:: Cls.meth2
|
|
|
|
.. explicit module given
|
|
.. exception:: Error(arg1, arg2)
|
|
:module: errmod
|
|
|
|
.. data:: var
|
|
|
|
|
|
.. currentmodule:: None
|
|
|
|
.. function:: func_without_module2() -> annotation
|
|
|
|
.. class:: TimeInt
|
|
|
|
.. class:: Time(hour, minute, isdst)
|
|
|
|
:param hour: The year.
|
|
:type hour: TimeInt
|
|
:param TimeInt minute: The minute.
|
|
:param isdst: whether it's DST
|
|
:type isdst: * some complex
|
|
* expression
|
|
:returns: a new :class:`Time` instance
|
|
:rtype: :class:`Time`
|
|
:raises ValueError: if the values are out of range
|
|
:ivar int hour: like *hour*
|
|
:ivar minute: like *minute*
|
|
:vartype minute: int
|
|
|
|
|
|
C items
|
|
=======
|
|
|
|
.. c:function:: Sphinx_DoSomething()
|
|
|
|
.. c:member:: SphinxStruct.member
|
|
|
|
.. c:macro:: SPHINX_USE_PYTHON
|
|
|
|
.. c:type:: SphinxType
|
|
|
|
.. c:var:: sphinx_global
|
|
|
|
|
|
References
|
|
==========
|
|
|
|
Referencing :class:`mod.Cls` or :Class:`mod.Cls` should be the same.
|
|
|
|
With target: :c:func:`Sphinx_DoSomething()` (parentheses are handled),
|
|
:c:member:`SphinxStruct.member`, :c:macro:`SPHINX_USE_PYTHON`,
|
|
:c:type:`SphinxType *` (pointer is handled), :c:data:`sphinx_global`.
|
|
|
|
Without target: :c:func:`CFunction`. :c:func:`!malloc`.
|
|
|
|
|
|
Others
|
|
======
|
|
|
|
.. envvar:: HOME
|
|
|
|
.. program:: python
|
|
|
|
.. cmdoption:: -c command
|
|
|
|
.. program:: perl
|
|
|
|
.. cmdoption:: -c
|
|
|
|
|
|
User markup
|
|
===========
|
|
|
|
.. userdesc:: myobj:parameter
|
|
|
|
Description of userdesc.
|
|
|
|
|
|
Referencing :userdescrole:`myobj`.
|