1. Luke Plant
  2. sphinx

Commits

Georg Brandl  committed c7d5bc6

Cross-reference to role docs.

  • Participants
  • Parent commits 51533db
  • Branches default

Comments (0)

Files changed (2)

File doc/domains.rst

View file
  • Ignore whitespace
    :param integer limit: maximum number of stack frames to show
 
 
+.. _python-roles:
+
 Cross-referencing Python objects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
       .. c:var:: PyObject* PyClass_Type
 
 
+.. _c-roles:
+
 Cross-referencing C constructs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
    Select the current C++ namespace for the following objects.
 
+
+.. _cpp-roles:
+
 These roles link to the given object types:
 
 .. rst:role:: cpp:class
 
    Describes the attribute *name* of *object*.
 
+.. _js-roles:
+
 These roles are provided to refer to the described objects:
 
 .. rst:role:: js:func
 
          Foo description.
 
+.. _rst-roles:
+
 These roles are provided to refer to the described objects:
 
 .. rst:role:: rst:dir

File doc/markup/inline.rst

View file
  • Ignore whitespace
   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 <python-roles>`
+* :ref:`C <c-roles>`
+* :ref:`C++ <cpp-roles>`
+* :ref:`JavaScript <js-roles>`
+* :ref:`ReST <rst-roles>`
+
+
 .. _ref-role:
 
 Cross-referencing arbitrary locations