SphinxModel

pydantic model documenteer.conf._toml.SphinxModel

Model for Sphinx configurations in documenteer.toml.

Parameters:

data (Any)

Show JSON schema

{
   "title": "SphinxModel",
   "description": "Model for Sphinx configurations in documenteer.toml.",
   "type": "object",
   "properties": {
      "rst_epilog_file": {
         "anyOf": [
            {
               "format": "file-path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Path to a reStructuredText file that is added to every source file. Use this file to define common links and substitutions.",
         "title": "Rst Epilog File"
      },
      "extensions": {
         "description": "Additional Sphinx extension.",
         "items": {
            "type": "string"
         },
         "title": "Extensions",
         "type": "array"
      },
      "nitpicky": {
         "default": false,
         "description": "Escalate warnings to build errors.",
         "title": "Nitpicky",
         "type": "boolean"
      },
      "nitpick_ignore": {
         "description": "Errors to ignore. First item is the type (like a role or directive) and the second is the target (like the argument to the role).",
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Nitpick Ignore",
         "type": "array"
      },
      "nitpick_ignore_regex": {
         "description": "Same as ``nitpick_ignore``, but both type and target are interpreted as regular expressions.",
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Nitpick Ignore Regex",
         "type": "array"
      },
      "disable_primary_sidebars": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Pages that should not have a primary sidebar. Can be the page's path (without extension) or a glob of pages. By default the homepage and change logs do not have a primary sidebar.",
         "title": "Disable Primary Sidebars"
      },
      "python_api_dir": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Directory path where the Python API reference documentation is created.",
         "title": "Python Api Dir"
      },
      "exclude": {
         "description": "List of paths to exclude from being considered as Sphinx content sources.",
         "items": {
            "type": "string"
         },
         "title": "Exclude",
         "type": "array"
      },
      "theme": {
         "$ref": "#/$defs/ThemeModel"
      },
      "intersphinx": {
         "$ref": "#/$defs/IntersphinxModel"
      },
      "linkcheck": {
         "$ref": "#/$defs/LinkCheckModel"
      },
      "redirects": {
         "additionalProperties": {
            "type": "string"
         },
         "description": "Mapping of paths to redirect to other paths. These redirects are implemented with sphinx-rediraffe.",
         "title": "Redirects",
         "type": "object"
      }
   },
   "$defs": {
      "IntersphinxModel": {
         "description": "Model for Intersphinx configurations in documenteer.toml.",
         "properties": {
            "projects": {
               "additionalProperties": {
                  "format": "uri",
                  "maxLength": 2083,
                  "minLength": 1,
                  "type": "string"
               },
               "description": "Mapping of projects and their URLs.",
               "title": "Projects",
               "type": "object"
            }
         },
         "title": "IntersphinxModel",
         "type": "object"
      },
      "LinkCheckModel": {
         "description": "Model for linkcheck builder configurations in documenteer.toml.",
         "properties": {
            "ignore": {
               "description": "Regular expressions of URLs to skip checking links",
               "items": {
                  "type": "string"
               },
               "title": "Ignore",
               "type": "array"
            }
         },
         "title": "LinkCheckModel",
         "type": "object"
      },
      "ThemeModel": {
         "description": "Model for theme configurations in documenteer.toml.",
         "properties": {
            "show_github_edit_link": {
               "default": true,
               "description": "Show a link to edit on GitHub if True",
               "title": "Show Github Edit Link",
               "type": "boolean"
            },
            "header_links_before_dropdown": {
               "default": 5,
               "description": "Number of links in the header nav before showing a 'More' dropdown.",
               "title": "Header Links Before Dropdown",
               "type": "integer"
            }
         },
         "title": "ThemeModel",
         "type": "object"
      }
   }
}

Fields:

• disable_primary_sidebars (list[str] | None)

• exclude (list[str])

• extensions (list[str])

• intersphinx (documenteer.conf._toml.IntersphinxModel)

• linkcheck (documenteer.conf._toml.LinkCheckModel)

• nitpick_ignore (list[tuple[str, str]])

• nitpick_ignore_regex (list[tuple[str, str]])

• nitpicky (bool)

• python_api_dir (str | None)

• redirects (dict[str, str])

• rst_epilog_file (pathlib.Path | None)

• theme (documenteer.conf._toml.ThemeModel)

field disable_primary_sidebars: list[str] | None = None

Pages that should not have a primary sidebar. Can be the page’s path (without extension) or a glob of pages. By default the homepage and change logs do not have a primary sidebar.

field exclude: list[str] [Optional]

List of paths to exclude from being considered as Sphinx content sources.

field extensions: list[str] [Optional]

Additional Sphinx extension.

field intersphinx: IntersphinxModel [Optional]

field linkcheck: LinkCheckModel [Optional]

field nitpick_ignore: list[tuple[str, str]] [Optional]

Errors to ignore. First item is the type (like a role or directive) and the second is the target (like the argument to the role).

field nitpick_ignore_regex: list[tuple[str, str]] [Optional]

Same as nitpick_ignore, but both type and target are interpreted as regular expressions.

field nitpicky: bool = False

Escalate warnings to build errors.

field python_api_dir: str | None = None

Directory path where the Python API reference documentation is created.

field redirects: dict[str, str] [Optional]

Mapping of paths to redirect to other paths. These redirects are implemented with sphinx-rediraffe.

field rst_epilog_file: FilePath | None = None

Path to a reStructuredText file that is added to every source file. Use this file to define common links and substitutions.

field theme: ThemeModel [Optional]