schema.json

{
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Python handler for mkdocstrings.",
  "type": "object",
  "properties": {
    "python": {
      "markdownDescription": "https://mkdocstrings.github.io/python/",
      "type": "object",
      "properties": {
        "import": {
          "title": "Inventories to import.",
          "markdownDescription": "https://mkdocstrings.github.io/python/usage/#global-only-options",
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "properties": {
                  "url": {
                    "title": "URL of the inventory file.",
                    "type": "string"
                  },
                  "base_url": {
                    "title": "Base URL used to build references URLs.",
                    "type": "string"
                  },
                  "domains": {
                    "title": "Domains to import from the inventory.",
                    "description": "If not defined it will only import 'py' domain.",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            ]
          }
        },
        "paths": {
          "title": "Local absolute/relative paths (relative to mkdocs.yml) to search packages into.",
          "markdownDescription": "https://mkdocstrings.github.io/python/usage/#paths",
          "type": "array",
          "items": {
            "type": "string",
            "format": "path"
          }
        },
        "load_external_modules": {
          "title": "Load external modules to resolve aliases.",
          "markdownDescription": "https://mkdocstrings.github.io/python/usage/#load_external_modules",
          "type": "boolean",
          "default": false
        },
        "options": {
          "title": "Options for collecting and rendering objects.",
          "markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
          "type": "object",
          "properties": {
            "docstring_style": {
              "title": "The docstring style to use when parsing docstrings.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_style",
              "enum": [
                "google",
                "numpy",
                "sphinx"
              ],
              "default": "google"
            },
            "docstring_options": {
              "title": "The options for the docstring parser.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_options",
              "default": null,
              "items": {
                "$ref": "https://raw.githubusercontent.com/mkdocstrings/griffe/master/docs/schema-docstrings-options.json"
              }
            },
            "show_root_heading": {
              "title": "Show the heading of the object at the root of the documentation tree.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_heading",
              "type": "boolean",
              "default": false
            },
            "show_root_toc_entry": {
              "title": "If the root heading is not shown, at least add a ToC entry for it.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_toc_entry",
              "type": "boolean",
              "default": true
            },
            "show_root_full_path": {
              "title": "Show the full Python path for the root object heading.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_full_path",
              "type": "boolean",
              "default": true
            },
            "show_root_members_full_path": {
              "title": "Show the full Python path of the root members.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_members_full_path",
              "type": "boolean",
              "default": false
            },
            "show_object_full_path": {
              "title": "Show the full Python path of every object.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_object_full_path",
              "type": "boolean",
              "default": false
            },
            "show_symbol_type_heading": {
              "title": "Show the symbol type in headings (e.g. mod, class, func and attr).",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_heading",
              "type": "boolean",
              "default": false
            },
            "show_symbol_type_toc": {
              "title": "Show the symbol type in the Table of Contents (e.g. mod, class, func and attr).",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc",
              "type": "boolean",
              "default": false
            },
            "show_category_heading": {
              "title": "When grouped by categories, show a heading for each category.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_category_heading",
              "type": "boolean",
              "default": false
            },
            "show_if_no_docstring": {
              "title": "Show the object heading even if it has no docstring or children with docstrings.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_if_no_docstring",
              "type": "boolean",
              "default": false
            },
            "show_signature": {
              "title": "Show methods and functions signatures.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature",
              "type": "boolean",
              "default": true
            },
            "show_signature_annotations": {
              "title": "Show the type annotations in methods and functions signatures.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature_annotations",
              "type": "boolean",
              "default": false
            },
            "separate_signature": {
              "title": "Whether to put the whole signature in a code block below the heading. If a formatter (Black or Ruff) is installed, the signature is also formatted using it.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#separate_signature",
              "type": "boolean",
              "default": false
            },
            "line_length": {
              "title": "Maximum line length when formatting code/signatures.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#line_length",
              "type": "integer",
              "default": 60
            },
            "merge_init_into_class": {
              "title": "Whether to merge the `__init__` method into the class' signature and docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#merge_init_into_class",
              "type": "boolean",
              "default": false
            },
            "show_docstring_attributes": {
              "title": "Whether to display the \"Attributes\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_attributes",
              "type": "boolean",
              "default": true
            },
            "show_docstring_description": {
              "title": "Whether to display the textual block (including admonitions) in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_description",
              "type": "boolean",
              "default": true
            },
            "show_docstring_examples": {
              "title": "Whether to display the \"Examples\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_examples",
              "type": "boolean",
              "default": true
            },
            "show_docstring_other_parameters": {
              "title": "Whether to display the \"Other Parameters\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_other_parameters",
              "type": "boolean",
              "default": true
            },
            "show_docstring_parameters": {
              "title": "Whether to display the \"Parameters\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_parameters",
              "type": "boolean",
              "default": true
            },
            "show_docstring_raises": {
              "title": "Whether to display the \"Raises\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_raises",
              "type": "boolean",
              "default": true
            },
            "show_docstring_receives": {
              "title": "Whether to display the \"Receives\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_receives",
              "type": "boolean",
              "default": true
            },
            "show_docstring_returns": {
              "title": "Whether to display the \"Returns\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_returns",
              "type": "boolean",
              "default": true
            },
            "show_docstring_warns": {
              "title": "Whether to display the \"Warns\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_warns",
              "type": "boolean",
              "default": true
            },
            "show_docstring_yields": {
              "title": "Whether to display the \"Yields\" section in the object's docstring.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_yields",
              "type": "boolean",
              "default": true
            },
            "show_source": {
              "title": "Show the source code of this object.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#show_source",
              "type": "boolean",
              "default": true
            },
            "show_bases": {
              "title": "Show the base classes of a class.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#show_bases",
              "type": "boolean",
              "default": true
            },
            "show_submodules": {
              "title": "When rendering a module, show its submodules recursively.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#show_submodules",
              "type": "boolean",
              "default": false
            },
            "group_by_category": {
              "title": "Group the object's children by categories: attributes, classes, functions, and modules.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#group_by_category",
              "type": "boolean",
              "default": true
            },
            "heading_level": {
              "title": "The initial heading level to use.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#heading_level",
              "type": "integer",
              "default": 2
            },
            "members_order": {
              "title": "The members ordering to use.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#members_order",
              "enum": [
                "alphabetical",
                "source"
              ],
              "default": "alphabetical"
            },
            "docstring_section_style": {
              "title": "The style used to render docstring sections.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_section_style",
              "enum": [
                "list",
                "spacy",
                "table"
              ],
              "default": "table"
            },
            "members": {
              "title": "An explicit list of members to render.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#members",
              "type": [
                "boolean",
                "array"
              ],
              "default": null
            },
            "filters": {
              "title": "A list of filters applied to filter objects based on their name. A filter starting with `!` will exclude matching objects instead of including them. The `members` option takes precedence over `filters` (filters will still be applied recursively to lower members in the hierarchy).",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#filters",
              "type": "array",
              "default": [
                "!^_[^_]"
              ]
            },
            "annotations_path": {
              "title": "The verbosity for annotations path.",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#annotations_path",
              "enum": [
                "brief",
                "source"
              ],
              "default": "brief"
            },
            "preload_modules": {
              "title": "Pre-load modules. It permits to resolve aliases pointing to these modules (packages), and therefore render members of an object that are external to the given object (originating from another package).",
              "markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#preload_modules",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}