{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Raises": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Yields": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Methods": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Returns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Generate documentation IR for a given package."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Receives": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warnings": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Attributes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "First item should be the root package to import; if subpackages need to be analyzed but are not accessible from the root pass them as extra arguments."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "This takes a single file and builds the IR for a single package. Building for multiple packages may have side effects (for example importing seaborn changes matplotlib defaults)."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Other Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    }
  },
  "_ordered_sections": [
    "Summary",
    "Extended Summary",
    "Parameters",
    "Attributes",
    "Methods",
    "Returns",
    "Yields",
    "Receives",
    "Other Parameters",
    "Raises",
    "Warns",
    "Warnings",
    "Notes"
  ],
  "item_file": "/papyri/cli/gen.py",
  "item_line": 16,
  "item_type": "function",
  "aliases": [
    "papyri.cli.gen.gen"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "file",
        "annotation": "Annotated[str, typer.Argument(help='toml configuration file', autocompletion=_find_toml)]",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "infer",
        "annotation": "bool | None",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "exec",
        "annotation": "bool | None",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "debug",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "False"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "no_progress",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "dry_run",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "False"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "api",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "True"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "examples",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "True"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "narrative",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "True"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "fail",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "fail_early",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "fail_unseen_error",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "only",
        "annotation": "list[str]",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "upload",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "pack",
        "annotation": "bool",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "<typer.models.OptionInfo object at 0x0000>"
      }
    ],
    "return_annotation": "None",
    "target_name": "gen"
  },
  "references": null,
  "qa": "papyri.cli.gen:gen",
  "arbitrary": [],
  "local_refs": []
}