{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {},
  "_ordered_sections": [],
  "item_file": null,
  "item_line": null,
  "item_type": null,
  "aliases": [],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": null,
  "references": null,
  "qa": "specimens:inline",
  "arbitrary": [
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "This page collects everything that happens "
            },
            {
              "__type": "Emphasis",
              "__tag": 4047,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "inside"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " a paragraph: text-level emphasis, literals, inline math, and the inline "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":role:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " family."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Inline text and roles"
        }
      ],
      "level": 0,
      "target": "specimen-inline"
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "One asterisk is "
            },
            {
              "__type": "Emphasis",
              "__tag": 4047,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "emphasis"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (rendered as italic), two asterisks are "
            },
            {
              "__type": "Strong",
              "__tag": 4048,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "strong"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (rendered as bold). They can sit next to each other — "
            },
            {
              "__type": "Emphasis",
              "__tag": 4047,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "this is emphasised"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "Strong",
              "__tag": 4048,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "this is strong"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " — within ordinary running text."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Emphasis and strong"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Double backticks produce an inline literal: "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "papyri gen"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "--no-api"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "~/.papyri/data/"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". Literals are not parsed for further markup, so "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "*not emphasised*"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " stays verbatim with its asterisks intact."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Inline literals"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":math:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " role typesets a short expression inline with the surrounding prose: the area of a circle is "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "A = \\pi r^2"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", and Euler's identity "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "e^{i\\pi} + 1 = 0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " reads naturally mid-sentence. Display (block) math lives on the "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "tables and math page",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "specimens:tables-and-math"
              },
              "kind": "exists"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Inline math"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "A family of roles exists purely to mark "
            },
            {
              "__type": "Emphasis",
              "__tag": 4047,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "what kind of thing"
                }
              ]
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " a span of text is. papyri does not cross-link these — they render as inline code — but they keep the source semantic and round-trip cleanly:"
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "~/.papyri/config.toml"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — a filesystem path ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":file:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ")."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "Ctrl+C"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — a keystroke ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":kbd:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ")."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "papyri upload"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — a shell command ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":command:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ")."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "papyri"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — a program name ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":program:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ")."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "gen {config}.toml"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — a literal with a placeholder ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":samp:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ")."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "Esc"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " then "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":wq"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " — keystrokes chained in prose."
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "C-domain roles such as "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":c:func:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":c:type:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " also render as inline code, since papyri does not index C symbols: "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "PyList_Append"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "PyObject"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " appear verbatim."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Formatting-only roles"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "When the project config sets "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "[meta].github_slug"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", the IPython-style GitHub roles become links: pull request "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "#42"
                }
              ],
              "url": "https://github.com/jupyter/papyri/pull/42",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and issue "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "#7"
                }
              ],
              "url": "https://github.com/jupyter/papyri/issues/7",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " link into the configured repository. Without a slug they degrade gracefully to plain "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "#N"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " text."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":pep:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " role links to python.org: "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "Pep 8"
                }
              ],
              "url": "https://peps.python.org/pep-0008/",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (style), "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "Pep 257"
                }
              ],
              "url": "https://peps.python.org/pep-0257/",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (docstrings), and "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "Pep 440"
                }
              ],
              "url": "https://peps.python.org/pep-0440/",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (version identifiers)."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Cross-reference roles such as "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":func:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":class:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", and "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": ":ref:"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " are covered on the "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "cross-references page",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "specimens:crossrefs"
              },
              "kind": "exists"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "GitHub and PEP roles"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Strong",
                      "__tag": 4048,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "Substitutions"
                        }
                      ]
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "|name|"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " with a "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ".. |name| replace::"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " definition):   "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "replace::"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " text substitutions are resolved at gen time; image and unicode   substitutions are warned and dropped. The IR never carries a substitution   node."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "There is no inline role for arbitrary HTML or raw output — the "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "raw"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "   directive is dropped for security, and there is no inline equivalent."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Strong",
                      "__tag": 4048,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "Subscript / superscript"
                        }
                      ]
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":sub:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " / "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": ":sup:"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "): accepted without error   but rendered as verbatim inline code, not raised/lowered text. There is no   true sub/superscript node, so "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "H\\ :sub:`2`\\ O"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " reads as "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "H 2 O"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " in   monospace rather than H₂O."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Not supported"
        }
      ],
      "level": 1,
      "target": null
    }
  ],
  "local_refs": []
}