mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
refs #3458: add sphinx.testing that are moved from /tests directory.
This commit is contained in:
213
tests/roots/test-root/objects.txt
Normal file
213
tests/roots/test-root/objects.txt
Normal file
@@ -0,0 +1,213 @@
|
||||
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: Time
|
||||
:raises Error: 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
|
||||
:param .Cls extcls: A class from another module.
|
||||
|
||||
|
||||
C items
|
||||
=======
|
||||
|
||||
.. c:function:: Sphinx_DoSomething()
|
||||
|
||||
.. c:member:: SphinxStruct.member
|
||||
|
||||
.. c:macro:: SPHINX_USE_PYTHON
|
||||
|
||||
.. c:type:: SphinxType
|
||||
|
||||
.. c:var:: sphinx_global
|
||||
|
||||
|
||||
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
|
||||
|
||||
.. option:: +p
|
||||
|
||||
.. option:: --ObjC++
|
||||
|
||||
.. option:: --plugin.option
|
||||
|
||||
.. option:: create-auth-token
|
||||
|
||||
.. option:: arg
|
||||
|
||||
Link to :option:`perl +p`, :option:`--ObjC++`, :option:`--plugin.option`, :option:`create-auth-token` and :option:`arg`
|
||||
|
||||
.. program:: hg
|
||||
|
||||
.. option:: commit
|
||||
|
||||
.. program:: git commit
|
||||
|
||||
.. option:: -p
|
||||
|
||||
Link to :option:`hg commit` and :option:`git commit -p`.
|
||||
|
||||
|
||||
User markup
|
||||
===========
|
||||
|
||||
.. userdesc:: myobj:parameter
|
||||
|
||||
Description of userdesc.
|
||||
|
||||
|
||||
Referencing :userdescrole:`myobj`.
|
||||
|
||||
|
||||
CPP domain
|
||||
==========
|
||||
|
||||
.. cpp:class:: n::Array
|
||||
|
||||
.. cpp:function:: T& operator[]( unsigned j )
|
||||
const T& operator[]( unsigned j ) const
|
||||
Reference in New Issue
Block a user