IntersphinxCacheModel

pydantic model documenteer.conf._toml.IntersphinxCacheModel

Model for the Ook intersphinx inventory cache configuration in documenteer.toml.

Parameters:

data (Any)

Show JSON schema

{
   "title": "IntersphinxCacheModel",
   "description": "Model for the Ook intersphinx inventory cache configuration in\ndocumenteer.toml.",
   "type": "object",
   "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"
      },
      "warn_on_permanent_redirect": {
         "default": false,
         "description": "Report an intersphinx inventory URL that has permanently moved as a Sphinx warning rather than an informational message, so a warnings-as-errors (-W) build fails until the URL is updated. The warning carries the subtype documenteer.intersphinx_permanent_redirect, so it can be silenced per-project with suppress_warnings. Default is false because the move originates upstream, outside the author's control.",
         "title": "Warn On Permanent Redirect",
         "type": "boolean"
      }
   }
}

Fields:

• disk_cache_ttl (int)

• service_url (pydantic.networks.HttpUrl)

• use_service (bool)

• warn_on_permanent_redirect (bool)

field disk_cache_ttl: int = 600

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.

Constraints:

• ge = 0

field service_url: HttpUrl = HttpUrl('https://roundtable.lsst.cloud/ook')

Base URL of the Ook API that hosts the intersphinx inventory cache service.

field use_service: bool = True

Prefetch intersphinx object inventories from Ook’s inventory cache service so builds do not depend on third-party site availability.

field warn_on_permanent_redirect: bool = False

Report an intersphinx inventory URL that has permanently moved as a Sphinx warning rather than an informational message, so a warnings-as-errors (-W) build fails until the URL is updated. The warning carries the subtype documenteer.intersphinx_permanent_redirect, so it can be silenced per-project with suppress_warnings. Default is false because the move originates upstream, outside the author’s control.