{
  "code(docutils.parsers.rst.roles.code_role)": {
    "is_markdown": true,
    "description": [
      "## `:code:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | literal |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class), language |",
      "| Content | None. |",
      " |",
      "",
      "(New in Docutils 0.9.)",
      "",
      "The `code` role marks its content as code in a formal language.",
      "",
      "For syntax highlight of inline code, the [\"role\" directive](https:/docutils.sourceforge.io/docs/ref/rst/directives.html#role) can be used to",
      "build custom roles with the code language specified in the \"language\"",
      "option.",
      "",
      "For example, the following creates a LaTeX-specific \"latex\" role:",
      "",
      "```",
      ".. role:: latex(code)",
      "   :language: latex",
      "```",
      "",
      "Content of the new role is parsed and tagged by the [Pygments](https://pygments.org/) syntax",
      "highlighter. See the [code directive](https:/docutils.sourceforge.io/docs/ref/rst/directives.html#code) for more info on parsing and display",
      "of code in reStructuredText.",
      "",
      "In addition to \"[class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class)\", the following option is recognized:",
      "",
      "`language`: text",
      "Name of the code's language.",
      "See [supported languages and markup formats](https://pygments.org/languages/) for recognized values."
    ],
    "options": {
      "language": "text\nName of the code's language.\nSee [supported languages and markup formats](https://pygments.org/languages/) for recognized values.\n"
    },
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#code",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "emphasis(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:emphasis:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | emphasis |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "Implements emphasis.  These are equivalent:",
      "",
      "```",
      "*text*",
      ":emphasis:`text`",
      "```"
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#emphasis",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "literal(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:literal:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | literal |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "Implements inline literal text.  These are equivalent:",
      "",
      "```",
      "``text``",
      ":literal:`text`",
      "```",
      "",
      "Care must be taken with backslash-escapes though.  These are not",
      "equivalent:",
      "",
      "```",
      "``text \\ and \\ backslashes``",
      ":literal:`text \\ and \\ backslashes`",
      "```",
      "",
      "The backslashes in the first line are preserved (and do nothing),",
      "whereas the backslashes in the second line escape the following",
      "spaces."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#literal",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "math(docutils.parsers.rst.roles.math_role)": {
    "is_markdown": true,
    "description": [
      "## `:math:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | math |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class) |",
      "| Content | None. |",
      " |",
      "",
      "(New in Docutils 0.8.)",
      "",
      "The `math` role marks its content as mathematical notation (inline",
      "formula).",
      "",
      "The input format is LaTeX math syntax without the \u201cmath delimiters\u201c",
      "(`$ $`), for example:",
      "",
      "```",
      "The area of a circle is :math:`A_\\text{c} = (\\pi/4) d^2`.",
      "```",
      "",
      "See the [math directive](https:/docutils.sourceforge.io/docs/ref/rst/directives.html#math) (producing display formulas) for more info",
      "on mathematical notation in reStructuredText."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#math",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "pep-reference(docutils.parsers.rst.roles.pep_reference_role)": {
    "is_markdown": true,
    "description": [
      "## `:pep-reference:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | `:PEP:` |",
      "| DTD Element | reference |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "The `:pep-reference:` role is used to create an HTTP reference to a",
      "PEP (Python Enhancement Proposal).  The `:PEP:` alias is usually",
      "used.  The content must be a number, for example:",
      "",
      "```",
      "See :PEP:`287` for more information about reStructuredText.",
      "```",
      "",
      "This is equivalent to:",
      "",
      "```",
      "See `PEP 287`__ for more information about reStructuredText.",
      "",
      "__ https://www.python.org/dev/peps/pep-0287",
      "```"
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#pep-reference",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "raw(docutils.parsers.rst.roles.raw_role)": {
    "is_markdown": true,
    "description": [
      "## `raw`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | raw |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class), format |",
      "| Content | None |",
      " |",
      "",
      "The \"raw\" role is a stop-gap measure allowing the author to bypass",
      "reStructuredText's markup.  It is a \"power-user\" feature that",
      "should not be overused or abused.  The use of \"raw\" ties documents",
      "to specific output formats and makes them less portable.",
      "",
      "If you often need to use \"raw\"-derived interpreted text roles or",
      "the \"raw\" directive, that is a sign either of overuse/abuse or that",
      "functionality may be missing from reStructuredText.  Please",
      "describe your situation in a message to the [Docutils-users](https:/docutils.sourceforge.io/docs/ref/rst/../../user/mailing-lists.html#docutils-user) mailing",
      "list.",
      "",
      "The \"raw\" role indicates non-reStructuredText data that is to be",
      "passed untouched to the Writer.  It is the inline equivalent of the",
      "[\"raw\" directive](https:/docutils.sourceforge.io/docs/ref/rst/directives.html#raw-directive); see its documentation for details on the",
      "semantics.",
      "",
      "The \"raw\" role cannot be used directly.  The [\"role\" directive](https:/docutils.sourceforge.io/docs/ref/rst/directives.html#role) must",
      "first be used to build custom roles based on the \"raw\" role.  One or",
      "more formats (Writer names) must be provided in a \"format\" option.",
      "",
      "For example, the following creates an HTML-specific \"raw-html\" role:",
      "",
      "```",
      ".. role:: raw-html(raw)",
      "   :format: html",
      "```",
      "",
      "This role can now be used directly to pass data untouched to the HTML",
      "Writer.  For example:",
      "",
      "```",
      "If there just *has* to be a line break here,",
      ":raw-html:`<br />`",
      "it can be accomplished with a \"raw\"-derived role.",
      "But the line block syntax should be considered first.",
      "```",
      "",
      "Roles based on \"raw\" should clearly indicate their origin, so",
      "they are not mistaken for reStructuredText markup.  Using a \"raw-\"",
      "prefix for role names is recommended.",
      "",
      "In addition to \"[class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class)\", the following option is recognized:",
      "",
      "`format`: text",
      "One or more space-separated output format names (Writer names)."
    ],
    "options": {
      "format": "text\nOne or more space-separated output format names (Writer names).\n"
    },
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#raw",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "rfc-reference(docutils.parsers.rst.roles.rfc_reference_role)": {
    "is_markdown": true,
    "description": [
      "## `:rfc-reference:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | `:RFC:` |",
      "| DTD Element | reference |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "The `:rfc-reference:` role is used to create an HTTP reference to an",
      "RFC (Internet Request for Comments).  The `:RFC:` alias is usually",
      "used.  The content must be a number 1, for example:",
      "",
      "```",
      "See :RFC:`2822` for information about email headers.",
      "```",
      "",
      "This is equivalent to:",
      "",
      "```",
      "See `RFC 2822`__ for information about email headers.",
      "",
      "__ https://tools.ietf.org/html/rfc2822.html",
      "```",
      "1",
      "You can link to a specific section by saying",
      "`:rfc:`number#anchor``. (New in Docutils 0.15.)",
      "",
      "The anchor (anything following a `#`) is appended to",
      "the reference without any checks and not shown in the link text.",
      "",
      "It is recommended to use [hyperlink references](https:/docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-references) for",
      "anything more complex than a single RFC number."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#rfc-reference",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "strong(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:strong:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | None |",
      "| DTD Element | strong |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "Implements strong emphasis.  These are equivalent:",
      "",
      "```",
      "**text**",
      ":strong:`text`",
      "```"
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#strong",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "subscript(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:subscript:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | `:sub:` |",
      "| DTD Element | subscript |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "Implements subscripts.",
      "",
      "Whitespace or punctuation is required around interpreted text, but",
      "often not desired with subscripts & superscripts.",
      "Backslash-escaped whitespace can be used; the whitespace will be",
      "removed from the processed document:",
      "",
      "```",
      "H\\ :sub:`2`\\ O",
      "E = mc\\ :sup:`2`",
      "```",
      "",
      "In such cases, readability of the plain text can be greatly",
      "improved with substitutions:",
      "",
      "```",
      "The chemical formula for pure water is |H2O|.",
      "",
      ".. |H2O| replace:: H\\ :sub:`2`\\ O",
      "```",
      "",
      "See [the reStructuredText spec](https:/docutils.sourceforge.io/docs/ref/rst/restructuredtext.html) for further information on",
      "[character-level markup](https:/docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#character-level-inline-markup) and [the substitution mechanism](https:/docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#substitution-references)."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#subscript",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "superscript(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:superscript:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | `:sup:` |",
      "| DTD Element | superscript |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "Implements superscripts.  See the tip in [:subscript:](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#subscript) above."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#superscript",
    "license": "https://docutils.sourceforge.io/docs/"
  },
  "title-reference(docutils.parsers.rst.roles.GenericRole)": {
    "is_markdown": true,
    "description": [
      "## `:title-reference:`",
      "",
      "| | |",
      "|-|-|",
      "| Aliases | `:title:`, `:t:`. |",
      "| DTD Element | title_reference |",
      "| Customization | ",
      "| | |",
      "|-|-|",
      "| Options | [class](https://docutils.sourceforge.io/docs/ref/rst/roles.txt#class). |",
      "| Content | None. |",
      " |",
      "",
      "The `:title-reference:` role is used to describe the titles of",
      "books, periodicals, and other materials.  It is the equivalent of the",
      "HTML \"cite\" element, and it is expected that HTML writers will",
      "typically render \"title_reference\" elements using \"cite\".",
      "",
      "Since title references are typically rendered with italics, they are",
      "often marked up using `*emphasis*`, which is misleading and vague.",
      "The \"title_reference\" element provides accurate and unambiguous",
      "descriptive markup.",
      "",
      "Let's assume `:title-reference:` is the default interpreted text",
      "role (see below) for this example:",
      "",
      "```",
      "`Design Patterns` [GoF95]_ is an excellent read.",
      "```",
      "",
      "The following document fragment ([pseudo-XML](https:/docutils.sourceforge.io/docs/ref/rst/../doctree.html#pseudo-xml)) will result from",
      "processing:",
      "",
      "```",
      "<paragraph>",
      "    <title_reference>",
      "        Design Patterns",
      "",
      "    <citation_reference refname=\"gof95\">",
      "        GoF95",
      "     is an excellent read.",
      "```",
      "",
      "`:title-reference:` is the default interpreted text role in the",
      "standard reStructuredText parser.  This means that no explicit role is",
      "required.  Applications of reStructuredText may designate a different",
      "default role, in which case the explicit `:title-reference:` role",
      "must be used to obtain a `title_reference` element."
    ],
    "options": {},
    "source": "https://docutils.sourceforge.io/docs/ref/rst/roles.html#title-reference",
    "license": "https://docutils.sourceforge.io/docs/"
  }
}