mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
718f4a6f8c
If an unknown field name is encountered, a space is only appended if the field arguments are not empty. Also, only the first character of the field name is upper cased, and the case of the rest of the string remains unchanged.
199 lines
3.4 KiB
Plaintext
199 lines
3.4 KiB
Plaintext
Testing object descriptions
|
|
===========================
|
|
|
|
.. function:: func_without_module(a, b, *c[, d])
|
|
|
|
Does something.
|
|
|
|
.. function:: func_without_body()
|
|
|
|
.. function:: func_with_unknown_field()
|
|
|
|
: :
|
|
|
|
: empty field name:
|
|
|
|
:field_name:
|
|
|
|
:field_name all lower:
|
|
|
|
:FIELD_NAME:
|
|
|
|
:FIELD_NAME ALL CAPS:
|
|
|
|
:Field_Name:
|
|
|
|
:Field_Name All Word Caps:
|
|
|
|
:Field_name:
|
|
|
|
:Field_name First word cap:
|
|
|
|
:FIELd_name:
|
|
|
|
:FIELd_name PARTial caps:
|
|
|
|
.. function:: func_noindex
|
|
:noindex:
|
|
|
|
.. function:: func_with_module
|
|
:module: foolib
|
|
|
|
Referring to :func:`func with no index <func_noindex>`.
|
|
Referring to :func:`nothing <>`.
|
|
|
|
.. 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
|
|
|
|
.. object:: long(parameter, \
|
|
list)
|
|
another one
|
|
|
|
.. class:: TimeInt
|
|
|
|
Has only one parameter (triggers special behavior...)
|
|
|
|
:param moo: |test|
|
|
:type moo: |test|
|
|
|
|
.. |test| replace:: Moo
|
|
|
|
.. class:: Time(hour, minute, isdst)
|
|
|
|
:param year: The year.
|
|
:type year: 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
|
|
:param hour: Some parameter
|
|
:type hour: DuplicateType
|
|
:param hour: Duplicate param. Should not lead to crashes.
|
|
:type hour: DuplicateType
|
|
|
|
|
|
C items
|
|
=======
|
|
|
|
.. c:function:: Sphinx_DoSomething()
|
|
|
|
.. c:member:: SphinxStruct.member
|
|
|
|
.. c:macro:: SPHINX_USE_PYTHON
|
|
|
|
.. c:type:: SphinxType
|
|
|
|
.. c:var:: sphinx_global
|
|
|
|
|
|
Old C items (from oldcmarkup ext)
|
|
---------------------------------
|
|
|
|
.. cfunction:: Sphinx_Func()
|
|
|
|
Refer to :cfunc:`Sphinx_Func`.
|
|
|
|
|
|
Javascript items
|
|
================
|
|
|
|
.. js:function:: foo()
|
|
|
|
.. js:data:: bar
|
|
|
|
.. documenting the method of any object
|
|
.. js:function:: bar.baz(href, callback[, errback])
|
|
|
|
:param string href: The location of the resource.
|
|
:param callback: Get's called with the data returned by the resource.
|
|
:throws InvalidHref: If the `href` is invalid.
|
|
:returns: `undefined`
|
|
|
|
.. js:attribute:: bar.spam
|
|
|
|
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`.
|
|
|
|
:js:func:`foo()`
|
|
:js:func:`foo`
|
|
|
|
:js:data:`bar`
|
|
:js:func:`bar.baz()`
|
|
:js:func:`bar.baz`
|
|
:js:func:`~bar.baz()`
|
|
|
|
:js:attr:`bar.baz`
|
|
|
|
|
|
Others
|
|
======
|
|
|
|
.. envvar:: HOME
|
|
|
|
.. program:: python
|
|
|
|
.. cmdoption:: -c command
|
|
|
|
.. program:: perl
|
|
|
|
.. cmdoption:: -c
|
|
|
|
|
|
User markup
|
|
===========
|
|
|
|
.. userdesc:: myobj:parameter
|
|
|
|
Description of userdesc.
|
|
|
|
|
|
Referencing :userdescrole:`myobj`.
|
|
|
|
|
|
CPP domain
|
|
==========
|
|
|
|
.. cpp:class:: n::Array<T,d>
|
|
|
|
.. cpp:function:: T& operator[]( unsigned j )
|
|
const T& operator[]( unsigned j ) const
|