schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Schema for Read the Docs configuration file",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "string",
      "enum": [
        "2"
      ]
    },
    "formats": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "htmlzip",
          "pdf",
          "epub",
          "all"
        ]
      }
    },
    "conda": {
      "additionalProperties": false,
      "properties": {
        "environment": {
          "type": "string"
        }
      },
      "required": [
        "conda"
      ]
    },
    "build": {
      "additionalProperties": false,
      "properties": {
        "image": {
          "type": "string",
          "enum": [
            "stable",
            "latest"
          ],
          "default": "latest"
        }
      }
    },
    "python": {
      "additionalProperties": false,
      "properties": {
        "version": {
          "type": "string",
          "enum": [
            "2",
            "2.7",
            "3",
            "3.3",
            "3.4",
            "3.5",
            "3.6"
          ],
          "default": "3"
        },
        "system_packages": {
          "type": "boolean",
          "default": false
        },
        "install": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "requirements": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "requirements"
                ]
              },
              {
                "additionalProperties": false,
                "properties": {
                  "path": {
                    "type": "string"
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "pip",
                      "setuptools"
                    ],
                    "default": "pip"
                  },
                  "extra_requirements": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "default": []
                  }
                },
                "required": [
                  "path"
                ]
              },
              {
                "additionalProperties": false,
                "properties": {
                  "pipfile": {
                    "type": "string"
                  },
                  "dev": {
                    "type": "boolean",
                    "default": false
                  },
                  "ignore_pipfile": {
                    "type": "boolean",
                    "default": false
                  },
                  "skip_lock": {
                    "type": "boolean",
                    "default": true
                  }
                },
                "required": [
                  "pipfile"
                ]
              }
            ]
          }
        }
      }
    },
    "sphinx": {
      "additionalProperties": false,
      "properties": {
        "builder": {
          "type": "string",
          "enum": ["html", "htmldir", "dirhtml", "singlehtml"],
          "default": "html"
        },
        "configuration": {
          "type": "string"
        },
        "fail_on_warning": {
          "type": "boolean",
          "default": false
        }
      }
    },
    "mkdocs": {
      "additionalProperties": false,
      "properties": {
        "configuration": {
          "type": "string"
        },
        "fail_on_warning": {
          "type": "boolean",
          "default": false
        }
      }
    },
    "submodules": {
      "additionalProperties": false,
      "properties": {
        "include": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "all"
              ]
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ],
          "default": []
        },
        "exclude": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "all"
              ]
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ],
          "default": []
        },
        "recursive": {
          "type": "boolean",
          "default": false
        }
      }
    },
    "redirects": {
      "type": "object",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "page": {
              "type": "object",
              "additionalProperties": true,
              "minProperties": 1
            }
          }
        }
      ]
    }
  },
  "required": [
    "version"
  ]
}