LinkCheckModel

pydantic model documenteer.conf._toml.LinkCheckModel

Model for linkcheck builder configurations in documenteer.toml.

Parameters:

data (Any)

Show JSON schema

{
   "title": "LinkCheckModel",
   "description": "Model for linkcheck builder configurations in documenteer.toml.",
   "type": "object",
   "properties": {
      "ignore": {
         "description": "Regular expressions of URLs to skip checking links",
         "items": {
            "type": "string"
         },
         "title": "Ignore",
         "type": "array"
      },
      "use_service": {
         "default": true,
         "description": "Check links with Ook's link-check service instead of Sphinx's built-in linkcheck builder.",
         "title": "Use Service",
         "type": "boolean"
      },
      "service_url": {
         "default": "https://roundtable.lsst.cloud/ook",
         "description": "Base URL of the Ook API that hosts the link-check service.",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Service Url",
         "type": "string"
      },
      "poll_budget": {
         "default": 300,
         "description": "Maximum time (seconds) to wait for link-check results from the service.",
         "title": "Poll Budget",
         "type": "integer"
      },
      "strict": {
         "default": false,
         "description": "Fail the build when the link-check service is unavailable instead of degrading to a warning.",
         "title": "Strict",
         "type": "boolean"
      },
      "recheck_unverified": {
         "default": true,
         "description": "Recheck URLs the link-check service could not verify from its own vantage point \u2014 blocked by bot protection, or broken with no HTTP status code because it got no response at all \u2014 from this build's own vantage point, merging what the build observes into the report.",
         "title": "Recheck Unverified",
         "type": "boolean"
      },
      "origin_base_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Origin base URL override for the link-check service: the full base URL of the website the links are submitted for (e.g. https://documenteer.lsst.io). By default the origin is project.base_url. The URL is normalized by lowercasing the host and stripping any trailing slash.",
         "title": "Origin Base Url"
      }
   }
}

Fields:

• ignore (list[str])

• origin_base_url (pydantic.networks.HttpUrl | None)

• poll_budget (int)

• recheck_unverified (bool)

• service_url (pydantic.networks.HttpUrl)

• strict (bool)

• use_service (bool)

field ignore: list[str] [Optional]

Regular expressions of URLs to skip checking links

field origin_base_url: HttpUrl | None = None

Origin base URL override for the link-check service: the full base URL of the website the links are submitted for (e.g. https://documenteer.lsst.io). By default the origin is project.base_url. The URL is normalized by lowercasing the host and stripping any trailing slash.

field poll_budget: int = 300

Maximum time (seconds) to wait for link-check results from the service.

field recheck_unverified: bool = True

Recheck URLs the link-check service could not verify from its own vantage point — blocked by bot protection, or broken with no HTTP status code because it got no response at all — from this build’s own vantage point, merging what the build observes into the report.

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

Base URL of the Ook API that hosts the link-check service.

field strict: bool = False

Fail the build when the link-check service is unavailable instead of degrading to a warning.

field use_service: bool = True

Check links with Ook’s link-check service instead of Sphinx’s built-in linkcheck builder.