{ "abbr(sphinx.roles.Abbreviation)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-abbr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "abbr", "is_markdown": true, "description": [ "An abbreviation. If the role content contains a parenthesized explanation,", "it will be treated specially: it will be shown in a tool-tip in HTML, and", "output only once in LaTeX.", "", "Example: `:abbr:`LIFO (last-in, first-out)``." ], "options": {} }, "any(sphinx.roles.AnyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-any", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "any", "is_markdown": true, "description": [ "This convenience role tries to do its best to find a valid target for its", "reference text.", "- First, it tries standard cross-reference targets that would be referenced", "by [doc](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc), [ref](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref) or [option](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-option).", "Custom objects added to the standard domain by extensions (see", "[.Sphinx.add_object_type](https://www.sphinx-doc.org/en/master/_sources/usage/restructuredtext/roles.rst.txt#None)) are also searched.", "- Then, it looks for objects (targets) in all loaded domains. It is up to", "the domains how specific a match must be. For example, in the Python", "domain a reference of `:any:`Builder`` would match the", "`sphinx.builders.Builder` class.", "", "If none or multiple targets are found, a warning will be emitted. In the", "case of multiple targets, you can change \"any\" to a specific role.", "", "This role is a good candidate for setting [default_role](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-default_role). If you", "do, you can write cross-references without a lot of markup overhead. For", "example, in this Python function documentation", "", "```", ".. function:: install()", "", " This function installs a `handler` for every signal known by the", " `signal` module. See the section `about-signals` for more information.", "```", "", "there could be references to a glossary term (usually `:term:`handler``), a", "Python module (usually `:py:mod:`signal`` or `:mod:`signal``) and a", "section (usually `:ref:`about-signals``).", "", "The [any](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-any) role also works together with the", "[sphinx.ext.intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx) extension: when no local cross-reference is", "found, all object types of intersphinx inventories are also searched." ], "options": {} }, "command(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-command", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "command", "is_markdown": true, "description": [ "The name of an OS-level command, such as `rm`." ], "options": {} }, "dfn(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-dfn", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "dfn", "is_markdown": true, "description": [ "Mark the defining instance of a term in the text. (No index entries are", "generated.)" ], "options": {} }, "doc(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "doc", "is_markdown": true, "description": [ "Link to the specified document; the document name can be specified in", "absolute or relative fashion. For example, if the reference", "`:doc:`parrot`` occurs in the document `sketches/index`, then the link", "refers to `sketches/parrot`. If the reference is `:doc:`/people`` or", "`:doc:`../people``, the link refers to `people`.", "", "If no explicit link text is given (like usual: `:doc:`Monty Python members", "``), the link caption will be the title of the given document." ], "options": {} }, "download(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-download", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "download", "is_markdown": true, "description": [ "This role lets you link to files within your source tree that are not reST", "documents that can be viewed, but files that can be downloaded.", "", "When you use this role, the referenced file is automatically marked for", "inclusion in the output when building (obviously, for HTML output only).", "All downloadable files are put into a `_downloads//`", "subdirectory of the output directory; duplicate filenames are handled.", "", "An example:", "", "```", "See :download:`this example script <../example.py>`.", "```", "", "The given filename is usually relative to the directory the current source", "file is contained in, but if it absolute (starting with `/`), it is taken", "as relative to the top source directory.", "", "The `example.py` file will be copied to the output directory, and a", "suitable link generated to it.", "", "Not to show unavailable download links, you should wrap whole paragraphs that", "have this role:", "", "```", ".. only:: builder_html", "", " See :download:`this example script <../example.py>`.", "```" ], "options": {} }, "envvar(sphinx.domains.std.EnvVarXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-envvar", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "envvar", "is_markdown": true, "description": [ "An environment variable. Index entries are generated. Also generates a link", "to the matching [envvar](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-envvar) directive, if it exists." ], "options": {} }, "eq(sphinx.domains.math.MathReferenceRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-eq", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "eq", "is_markdown": true, "description": [ "Same as [math:numref](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-math-numref)." ], "options": {} }, "file(sphinx.roles.EmphasizedLiteral)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "file", "is_markdown": true, "description": [ "The name of a file or directory. Within the contents, you can use curly", "braces to indicate a \"variable\" part, for example:", "", "```", "... is installed in :file:`/usr/lib/python2.{x}/site-packages` ...", "```", "", "In the built documentation, the `x` will be displayed differently to", "indicate that it is to be replaced by the Python minor version." ], "options": {} }, "guilabel(sphinx.roles.GUILabel)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-guilabel", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "guilabel", "is_markdown": true, "description": [ "Labels presented as part of an interactive user interface should be marked", "using `guilabel`. This includes labels from text-based interfaces such as", "those created using [curses](https://www.sphinx-doc.org/en/master/_sources/usage/restructuredtext/roles.rst.txt#None) or other text-based libraries. Any label", "used in the interface should be marked with this role, including button", "labels, window titles, field names, menu and menu selection names, and even", "values in selection lists." ], "options": {} }, "kbd(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-kbd", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "kbd", "is_markdown": true, "description": [ "Mark a sequence of keystrokes. What form the key sequence takes may depend", "on platform- or application-specific conventions. When there are no", "relevant conventions, the names of modifier keys should be spelled out, to", "improve accessibility for new users and non-native speakers. For example,", "an xemacs key sequence may be marked like `:kbd:`C-x C-f``, but without", "reference to a specific application or platform, the same sequence should be", "marked as `:kbd:`Control-x Control-f``." ], "options": {} }, "keyword(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-keyword", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "keyword", "is_markdown": true, "description": [ "The name of a keyword in Python. This creates a link to a reference label", "with that name, if it exists." ], "options": {} }, "mailheader(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-mailheader", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "mailheader", "is_markdown": true, "description": [ "The name of an RFC 822-style mail header. This markup does not imply that", "the header is being used in an email message, but can be used to refer to", "any header of the same \"style.\" This is also used for headers defined by", "the various MIME specifications. The header name should be entered in the", "same way it would normally be found in practice, with the camel-casing", "conventions being preferred where there is more than one common usage. For", "example: `:mailheader:`Content-Type``." ], "options": {} }, "makevar(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-makevar", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "makevar", "is_markdown": true, "description": [ "The name of a make variable." ], "options": {} }, "manpage(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "manpage", "is_markdown": true, "description": [ "A reference to a Unix manual page including the section, e.g.", "`:manpage:`ls(1)``. Creates a hyperlink to an external site rendering the", "manpage if [manpages_url](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url) is defined." ], "options": {} }, "math(docutils.parsers.rst.roles.math_role)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-math", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "math", "is_markdown": true, "description": [ "Role for inline math. Use like this:", "", "```", "Since Pythagoras, we know that :math:`a^2 + b^2 = c^2`.", "```" ], "options": {} }, "menuselection(sphinx.roles.MenuSelection)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-menuselection", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "menuselection", "is_markdown": true, "description": [ "Menu selections should be marked using the `menuselection` role. This is", "used to mark a complete sequence of menu selections, including selecting", "submenus and choosing a specific operation, or any subsequence of such a", "sequence. The names of individual selections should be separated by", "`-->`.", "", "For example, to mark the selection \"Start > Programs\", use this markup:", "", "```", ":menuselection:`Start --> Programs`", "```", "", "When including a selection that includes some trailing indicator, such as", "the ellipsis some operating systems use to indicate that the command opens a", "dialog, the indicator should be omitted from the selection name.", "", "`menuselection` also supports ampersand accelerators just like", "[guilabel](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-guilabel)." ], "options": {} }, "mimetype(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-mimetype", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "mimetype", "is_markdown": true, "description": [ "The name of a MIME type, or a component of a MIME type (the major or minor", "portion, taken alone)." ], "options": {} }, "newsgroup(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-newsgroup", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "newsgroup", "is_markdown": true, "description": [ "The name of a Usenet newsgroup." ], "options": {} }, "numref(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-numref", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "numref", "is_markdown": true, "description": [ "Link to the specified figures, tables, code-blocks and sections; the standard", "reST labels are used. When you use this role, it will insert a reference to", "the figure with link text by its figure number like \"Fig. 1.1\".", "", "If an explicit link text is given (as usual: `:numref:`Image of Sphinx (Fig.", "%s) ``), the link caption will serve as title of the reference.", "As placeholders, %s and {number} get replaced by the figure", "number and {name} by the figure caption.", "If no explicit link text is given, the [numfig_format](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-numfig_format) setting is", "used as fall-back default.", "", "If [numfig](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-numfig) is `False`, figures are not numbered,", "so this role inserts not a reference but the label or the link text." ], "options": {} }, "option(sphinx.domains.std.OptionXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-option", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "option", "is_markdown": true, "description": [ "A command-line option to an executable program. This generates a link to", "a [option](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option) directive, if it exists." ], "options": {} }, "pep(sphinx.roles.PEP)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-pep", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "pep", "is_markdown": true, "description": [ "A reference to a Python Enhancement Proposal. This generates appropriate", "index entries. The text \"PEP number\" is generated; in the HTML output,", "this text is a hyperlink to an online copy of the specified PEP. You can", "link to a specific section by saying `:pep:`number#anchor``." ], "options": {} }, "program(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-program", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "program", "is_markdown": true, "description": [ "The name of an executable program. This may differ from the file name for", "the executable for some platforms. In particular, the `.exe` (or other)", "extension should be omitted for Windows programs." ], "options": {} }, "ref(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "ref", "is_markdown": true, "description": [ "To support cross-referencing to arbitrary locations in any document, the", "standard reST labels are used. For this to work label names must be unique", "throughout the entire documentation. There are two ways in which you can", "refer to labels:", "- If you place a label directly before a section title, you can reference to", "it with `:ref:`label-name``. For example:", "", "```", ".. _my-reference-label:", "", "Section to cross-reference", "--------------------------", "", "This is the text of the section.", "", "It refers to the section itself, see :ref:`my-reference-label`.", "```", "The `:ref:` role would then generate a link to the section, with the", "link title being \"Section to cross-reference\". This works just as well", "when section and reference are in different source files.", "Automatic labels also work with figures. For example:", "", "```", ".. _my-figure:", "", ".. figure:: whatever", "", " Figure caption", "```", "In this case, a reference `:ref:`my-figure`` would insert a reference", "to the figure with link text \"Figure caption\".", "The same works for tables that are given an explicit caption using the", "[table](https://docutils.sourceforge.io/docs/ref/rst/directives.html#table) directive.", "- Labels that aren't placed before a section title can still be referenced,", "but you must give the link an explicit title, using this syntax:", "`:ref:`Link title ``.", "", "Reference labels must start with an underscore. When referencing a label,", "the underscore must be omitted (see examples above).", "", "Using [ref](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref) is advised over standard reStructuredText links to", "sections (like ``Section title`_`) because it works across files, when", "section headings are changed, will raise warnings if incorrect, and works", "for all builders that support cross-references." ], "options": {} }, "regexp(docutils.parsers.rst.roles.CustomRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-regexp", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "regexp", "is_markdown": true, "description": [ "A regular expression. Quotes should not be included." ], "options": {} }, "rfc(sphinx.roles.RFC)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-rfc", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "rfc", "is_markdown": true, "description": [ "A reference to an Internet Request for Comments. This generates appropriate", "index entries. The text \"RFC number\" is generated; in the HTML output,", "this text is a hyperlink to an online copy of the specified RFC. You can", "link to a specific section by saying `:rfc:`number#anchor``." ], "options": {} }, "samp(sphinx.roles.EmphasizedLiteral)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-samp", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "samp", "is_markdown": true, "description": [ "A piece of literal text, such as code. Within the contents, you can use", "curly braces to indicate a \"variable\" part, as in [file](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file). For", "example, in `:samp:`print 1+{variable}``, the part `variable` would be", "emphasized.", "", "If you don't need the \"variable part\" indication, use the standard", "```code``` instead." ], "options": {} }, "term(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-term", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "term", "is_markdown": true, "description": [ "Reference to a term in a glossary. A glossary is created using the", "`glossary` directive containing a definition list with terms and", "definitions. It does not have to be in the same file as the `term` markup,", "for example the Python docs have one global glossary in the `glossary.rst`", "file.", "", "If you use a term that's not explained in a glossary, you'll get a warning", "during build." ], "options": {} }, "token(sphinx.domains.std.TokenXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-token", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "token", "is_markdown": true, "description": [ "The name of a grammar token (used to create links between", "[productionlist](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-productionlist) directives)." ], "options": {} }, "c:data(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:data", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:enum(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-enum", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:enum", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:enumerator(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-enumerator", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:enumerator", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:expr(sphinx.domains.c.CExprRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-expr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:expr", "is_markdown": true, "description": [ "Insert a C expression or type either as inline code (`cpp:expr`)", "or inline text (`cpp:texpr`). For example:", "", "```", ".. c:var:: int a = 42", "", ".. c:function:: int f(int i)", "", "An expression: :c:expr:`a * f(a)` (or as text: :c:texpr:`a * f(a)`).", "", "A type: :c:expr:`const Data*`", "(or as text :c:texpr:`const Data*`).", "```", "", "will be rendered as follows:", "", "", "", "", "", "An expression: `a * f(a)` (or as text: `a * f(a)`).", "", "A type: `const Data*`", "(or as text `const Data*`)." ], "options": {} }, "c:func(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-func", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:func", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:macro(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-macro", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:macro", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:member(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:member", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:struct(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-struct", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:struct", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:texpr(sphinx.domains.c.CExprRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-texpr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:texpr", "is_markdown": true, "description": [ "Insert a C expression or type either as inline code (`cpp:expr`)", "or inline text (`cpp:texpr`). For example:", "", "```", ".. c:var:: int a = 42", "", ".. c:function:: int f(int i)", "", "An expression: :c:expr:`a * f(a)` (or as text: :c:texpr:`a * f(a)`).", "", "A type: :c:expr:`const Data*`", "(or as text :c:texpr:`const Data*`).", "```", "", "will be rendered as follows:", "", "", "", "", "", "An expression: `a * f(a)` (or as text: `a * f(a)`).", "", "A type: `const Data*`", "(or as text `const Data*`)." ], "options": {} }, "c:type(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-type", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:type", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:union(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-union", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:union", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "c:var(sphinx.domains.c.CXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "c:var", "is_markdown": true, "description": [ "Reference a C declaration, as defined above.", "Note that [c:member](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-member), [c:data](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-data), and", "[c:var](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-c-var) are equivalent." ], "options": {} }, "cpp:any(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-any", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:any", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:class(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-class", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:class", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:concept(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-concept", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:concept", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:enum(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-enum", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:enum", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:enumerator(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-enumerator", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:enumerator", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:expr(sphinx.domains.cpp.CPPExprRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-expr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:expr", "is_markdown": true, "description": [ "Insert a C++ expression or type either as inline code (`cpp:expr`)", "or inline text (`cpp:texpr`). For example:", "", "```", ".. cpp:var:: int a = 42", "", ".. cpp:function:: int f(int i)", "", "An expression: :cpp:expr:`a * f(a)` (or as text: :cpp:texpr:`a * f(a)`).", "", "A type: :cpp:expr:`const MySortedContainer&`", "(or as text :cpp:texpr:`const MySortedContainer&`).", "```", "", "will be rendered as follows:", "", "", "", "", "", "An expression: `a * f(a)` (or as text: `a * f(a)`).", "", "A type: `const MySortedContainer&`", "(or as text `const MySortedContainer&`)." ], "options": {} }, "cpp:func(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-func", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:func", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:member(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-member", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:member", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:struct(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-struct", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:struct", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:texpr(sphinx.domains.cpp.CPPExprRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-texpr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:texpr", "is_markdown": true, "description": [ "Insert a C++ expression or type either as inline code (`cpp:expr`)", "or inline text (`cpp:texpr`). For example:", "", "```", ".. cpp:var:: int a = 42", "", ".. cpp:function:: int f(int i)", "", "An expression: :cpp:expr:`a * f(a)` (or as text: :cpp:texpr:`a * f(a)`).", "", "A type: :cpp:expr:`const MySortedContainer&`", "(or as text :cpp:texpr:`const MySortedContainer&`).", "```", "", "will be rendered as follows:", "", "", "", "", "", "An expression: `a * f(a)` (or as text: `a * f(a)`).", "", "A type: `const MySortedContainer&`", "(or as text `const MySortedContainer&`)." ], "options": {} }, "cpp:type(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-type", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:type", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "cpp:var(sphinx.domains.cpp.CPPXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-cpp-var", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "cpp:var", "is_markdown": true, "description": [ "Reference a C++ declaration by name (see below for details). The name must", "be properly qualified relative to the position of the link." ], "options": {} }, "js:attr(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-attr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:attr", "is_markdown": true, "description": [ "" ], "options": {} }, "js:class(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-class", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:class", "is_markdown": true, "description": [ "" ], "options": {} }, "js:data(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-data", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:data", "is_markdown": true, "description": [ "" ], "options": {} }, "js:func(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-func", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:func", "is_markdown": true, "description": [ "" ], "options": {} }, "js:meth(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-meth", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:meth", "is_markdown": true, "description": [ "" ], "options": {} }, "js:mod(sphinx.domains.javascript.JSXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-js-mod", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "js:mod", "is_markdown": true, "description": [ "" ], "options": {} }, "math:numref(sphinx.domains.math.MathReferenceRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-math-numref", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "math:numref", "is_markdown": true, "description": [ "Role for cross-referencing equations defined by [math](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-math) directive", "via their label. Example:", "", "```", ".. math:: e^{i\\pi} + 1 = 0", " :label: euler", "", "Euler's identity, equation :math:numref:`euler`, was elected one of the", "most beautiful mathematical formulas.", "```" ], "options": {} }, "py:attr(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-attr", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:attr", "is_markdown": true, "description": [ "Reference a data attribute of an object.", "", "The role is also able to refer to property." ], "options": {} }, "py:class(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-class", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:class", "is_markdown": true, "description": [ "Reference a class; a dotted name may be used." ], "options": {} }, "py:const(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-const", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:const", "is_markdown": true, "description": [ "Reference a \"defined\" constant. This may be a Python variable that is not", "intended to be changed." ], "options": {} }, "py:data(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-data", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:data", "is_markdown": true, "description": [ "Reference a module-level variable." ], "options": {} }, "py:exc(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-exc", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:exc", "is_markdown": true, "description": [ "Reference an exception. A dotted name may be used." ], "options": {} }, "py:func(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-func", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:func", "is_markdown": true, "description": [ "Reference a Python function; dotted names may be used. The role text needs", "not include trailing parentheses to enhance readability; they will be added", "automatically by Sphinx if the [add_function_parentheses](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-add_function_parentheses) config", "value is `True` (the default)." ], "options": {} }, "py:meth(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-meth", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:meth", "is_markdown": true, "description": [ "Reference a method of an object. The role text can include the type name", "and the method name; if it occurs within the description of a type, the type", "name can be omitted. A dotted name may be used." ], "options": {} }, "py:mod(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-mod", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:mod", "is_markdown": true, "description": [ "Reference a module; a dotted name may be used. This should also be used for", "package names." ], "options": {} }, "py:obj(sphinx.domains.python.PyXRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-obj", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "py:obj", "is_markdown": true, "description": [ "Reference an object of unspecified type. Useful e.g. as the", "[default_role](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-default_role)." ], "options": {} }, "rst:dir(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-rst-dir", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "rst:dir", "is_markdown": true, "description": [ "" ], "options": {} }, "rst:role(sphinx.roles.XRefRole)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-rst-role", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "rst:role", "is_markdown": true, "description": [ "" ], "options": {} }, "index(docutils.parsers.rst.roles.unimplemented_role)": { "source": "https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#role-index", "license": "https://github.com/sphinx-doc/sphinx/blob/4.x/LICENSE", "name": "index", "is_markdown": true, "description": [ "While the [index](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-index) directive is a block-level markup and links to the", "beginning of the next paragraph, there is also a corresponding role that sets", "the link target directly where it is used.", "", "The content of the role can be a simple phrase, which is then kept in the", "text and used as an index entry. It can also be a combination of text and", "index entry, styled like with explicit targets of cross-references. In that", "case, the \"target\" part can be a full entry as described for the directive", "above. For example:", "", "```", "This is a normal reST :index:`paragraph` that contains several", ":index:`index entries `.", "```" ], "options": {} } }