From 8a3598ff8e5b17e8108ae85960c0976ef8ddbaa9 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 6 Jan 2011 20:44:55 +0100 Subject: [PATCH] Cross-reference to role docs. --- doc/domains.rst | 11 +++++++++++ doc/markup/inline.rst | 12 ++++++++++++ 2 files changed, 23 insertions(+) diff --git a/doc/domains.rst b/doc/domains.rst index 04fef38a5..6e6a9b26a 100644 --- a/doc/domains.rst +++ b/doc/domains.rst @@ -308,6 +308,8 @@ single word, like this:: :param integer limit: maximum number of stack frames to show +.. _python-roles: + Cross-referencing Python objects ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -438,6 +440,8 @@ The C domain (name **c**) is suited for documentation of C API. .. c:var:: PyObject* PyClass_Type +.. _c-roles: + Cross-referencing C constructs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -522,6 +526,9 @@ The following directives are available: Select the current C++ namespace for the following objects. + +.. _cpp-roles: + These roles link to the given object types: .. rst:role:: cpp:class @@ -689,6 +696,8 @@ The JavaScript domain (name **js**) provides the following directives: Describes the attribute *name* of *object*. +.. _js-roles: + These roles are provided to refer to the described objects: .. rst:role:: js:func @@ -740,6 +749,8 @@ The reStructuredText domain (name **rst**) provides the following directives: Foo description. +.. _rst-roles: + These roles are provided to refer to the described objects: .. rst:role:: rst:dir diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index 35981edc2..4f90a6a73 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -44,6 +44,18 @@ more versatile: tool-tip on mouse-hover) will always be the full target name. +Cross-referencing objects +------------------------- + +These roles are described with their respective domains: + +* :ref:`Python ` +* :ref:`C ` +* :ref:`C++ ` +* :ref:`JavaScript ` +* :ref:`ReST ` + + .. _ref-role: Cross-referencing arbitrary locations