IntersphinxModel

pydantic model documenteer.conf._toml.IntersphinxModel

Model for Intersphinx configurations in documenteer.toml.

Parameters:

data (Any)

Show JSON schema

{
   "title": "IntersphinxModel",
   "description": "Model for Intersphinx configurations in documenteer.toml.",
   "type": "object",
   "properties": {
      "projects": {
         "additionalProperties": {
            "format": "uri",
            "maxLength": 2083,
            "minLength": 1,
            "type": "string"
         },
         "description": "Mapping of projects and their URLs.",
         "title": "Projects",
         "type": "object"
      },
      "cache": {
         "$ref": "#/$defs/IntersphinxCacheModel"
      }
   },
   "$defs": {
      "IntersphinxCacheModel": {
         "description": "Model for the Ook intersphinx inventory cache configuration in\ndocumenteer.toml.",
         "properties": {
            "use_service": {
               "default": true,
               "description": "Prefetch intersphinx object inventories from Ook's inventory cache service so builds do not depend on third-party site availability.",
               "title": "Use Service",
               "type": "boolean"
            },
            "service_url": {
               "default": "https://roundtable.lsst.cloud/ook",
               "description": "Base URL of the Ook API that hosts the intersphinx inventory cache service.",
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Service Url",
               "type": "string"
            },
            "disk_cache_ttl": {
               "default": 600,
               "description": "Seconds an on-disk cached inventory stays fresh before the client revalidates it with Ook. Within this window, successive builds reuse the local file without contacting Ook at all. Set to 0 to disable the fast path so every build revalidates with Ook.",
               "minimum": 0,
               "title": "Disk Cache Ttl",
               "type": "integer"
            }
         },
         "title": "IntersphinxCacheModel",
         "type": "object"
      }
   }
}

Fields:

• cache (documenteer.conf._toml.IntersphinxCacheModel)

• projects (dict[str, pydantic.networks.HttpUrl])

field cache: IntersphinxCacheModel [Optional]

field projects: dict[str, HttpUrl] [Optional]

Mapping of projects and their URLs.