SphinxTable

pydantic model technote.sources.tomlsettings.SphinxTable

The [technote.sphinx] table permits Sphinx project configuration.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "SphinxTable",
   "description": "The ``[technote.sphinx]`` table permits Sphinx project configuration.",
   "type": "object",
   "properties": {
      "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"
      },
      "extensions": {
         "description": "Additional Sphinx extensions to use in the build.",
         "items": {
            "type": "string"
         },
         "title": "Extensions",
         "type": "array"
      },
      "intersphinx": {
         "allOf": [
            {
               "$ref": "#/$defs/IntersphinxTable"
            }
         ],
         "description": "Intersphinx configurations."
      },
      "linkcheck": {
         "allOf": [
            {
               "$ref": "#/$defs/LinkcheckTable"
            }
         ],
         "description": "Link check builder settings."
      }
   },
   "$defs": {
      "IntersphinxTable": {
         "description": "Intersphinx configuration in the ``[technote.sphinx]`` table.",
         "properties": {
            "projects": {
               "additionalProperties": {
                  "format": "uri",
                  "maxLength": 2083,
                  "minLength": 1,
                  "type": "string"
               },
               "description": "Mapping of projects and their URLs.",
               "title": "Projects",
               "type": "object"
            }
         },
         "title": "IntersphinxTable",
         "type": "object"
      },
      "LinkcheckTable": {
         "description": "Linkcheck builder configurations in the ``[technote.sphinx]`` table.",
         "properties": {
            "ignore": {
               "description": "Regular expressions of URLs to skip checking links",
               "items": {
                  "type": "string"
               },
               "title": "Ignore",
               "type": "array"
            }
         },
         "title": "LinkcheckTable",
         "type": "object"
      }
   }
}

Fields:

• extensions (list[str])

• intersphinx (technote.sources.tomlsettings.IntersphinxTable)

• linkcheck (technote.sources.tomlsettings.LinkcheckTable)

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

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

• nitpicky (bool)

field extensions: list[str] [Optional]

Additional Sphinx extensions to use in the build.

field intersphinx: IntersphinxTable [Optional]

Intersphinx configurations.

field linkcheck: LinkcheckTable [Optional]

Link check builder settings.

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.