Skip to content

Commit

Permalink
Config file: remove deprecated keys from json schema (#10867)
Browse files Browse the repository at this point in the history 
* Config file: remove deprecated keys

* Format
  • Loading branch information
@stsewd
stsewd authored Oct 24, 2023
1 parent 9d55392 commit 86698a9
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 192 deletions.
315 changes: 134 additions & 181 deletions readthedocs/rtd_tests/fixtures/spec/v2/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,214 +54,167 @@
"title": "Build",
"description": "Configuration for the documentation build process.",
"type": "object",
"anyOf": [
{
"properties": {
"os": {
"title": "Operating System",
"description": "Operating system to be used in the build.",
"enum": [
"ubuntu-20.04",
"ubuntu-22.04"
]
},
"jobs": {
"title": "Build jobs",
"description": "Run custom commands at any point in the build process",
"type": "object",
"properties": {
"image": {
"title": "Image",
"description": "DEPRECATED: use build.os instead.\n\nThe build docker image to be used.",
"enum": [
"stable",
"latest"
],
"default": "latest",
"deprecated": true
"post_checkout": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"apt_packages": {
"title": "APT Packages",
"description": "List of packages to be installed with apt-get.",
"pre_system_dependencies": {
"type": "array",
"items": {
"title": "APT Package",
"title": "Custom commands",
"type": "string"
},
"default": []
}
},
"additionalProperties": false
},
{
"properties": {
"os": {
"title": "Operating System",
"description": "Operating system to be used in the build.",
"enum": [
"ubuntu-20.04",
"ubuntu-22.04"
]
}
},
"jobs": {
"title": "Build jobs",
"description": "Run custom commands at any point in the build process",
"type": "object",
"properties": {
"post_checkout": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"pre_system_dependencies": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_system_dependencies": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"pre_create_environment": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_create_environment": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"pre_install": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_install": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"pre_build": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_build": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
}
},
"additionalProperties": false
"post_system_dependencies": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"tools": {
"title": "Tools",
"description": "Tools and their version to be used in the build.",
"type": "object",
"properties": {
"python": {
"enum": [
"2.7",
"3",
"3.6",
"3.7",
"3.8",
"3.9",
"3.10",
"3.11",
"3.12",
"miniconda3-4.7",
"mambaforge-4.10",
"mambaforge-22.9"
]
},
"nodejs": {
"enum": [
"14",
"16",
"18",
"19",
"20"
]
},
"rust": {
"enum": [
"1.55",
"1.61",
"1.64",
"1.70"
]
},
"golang": {
"enum": [
"1.17",
"1.18",
"1.19",
"1.20"
]
}
},
"minProperties": 1,
"additionalProperties": false
"pre_create_environment": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"apt_packages": {
"title": "APT Packages",
"description": "List of packages to be installed with apt-get.",
"post_create_environment": {
"type": "array",
"items": {
"title": "APT Package",
"title": "Custom commands",
"type": "string"
},
"default": []
}
},
"pre_install": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_install": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"commands": {
"title": "Build commands",
"description": "Override the whole build process with custom commands. When using this option, none of the commands from build.jobs will be executed.",
"pre_build": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
},
"post_build": {
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
}
},
"required": [
"os",
"tools"
],
"additionalProperties": false
},
"tools": {
"title": "Tools",
"description": "Tools and their version to be used in the build.",
"type": "object",
"properties": {
"python": {
"enum": [
"2.7",
"3",
"3.6",
"3.7",
"3.8",
"3.9",
"3.10",
"3.11",
"3.12",
"miniconda3-4.7",
"mambaforge-4.10",
"mambaforge-22.9"
]
},
"nodejs": {
"enum": [
"14",
"16",
"18",
"19",
"20"
]
},
"rust": {
"enum": [
"1.55",
"1.61",
"1.64",
"1.70"
]
},
"golang": {
"enum": [
"1.17",
"1.18",
"1.19",
"1.20"
]
}
},
"minProperties": 1,
"additionalProperties": false
},
"apt_packages": {
"title": "APT Packages",
"description": "List of packages to be installed with apt-get.",
"type": "array",
"items": {
"title": "APT Package",
"type": "string"
},
"default": []
},
"commands": {
"title": "Build commands",
"description": "Override the whole build process with custom commands. When using this option, none of the commands from build.jobs will be executed.",
"type": "array",
"items": {
"title": "Custom commands",
"type": "string"
}
}
]
},
"required": [
"os",
"tools"
],
"additionalProperties": false
},
"python": {
"title": "Python",
"description": "Configuration of the Python environment to be used.",
"type": "object",
"properties": {
"version": {
"title": "Version",
"description": "DEPRECATED: use build.tools.python instead.\n\nThe Python version to activate for your build (availability of Python versions depend on the build image).",
"type": "string",
"enum": [
"2",
"2.7",
"3",
"3.3",
"3.4",
"3.5",
"3.6",
"3.7",
"3.8"
],
"default": "3",
"deprecated": true
},
"install": {
"title": "Install",
"description": "Installation of packages and requiremens.",
Expand Down
11 changes: 0 additions & 11 deletions readthedocs/templates/projects/index.rst.html
View file

This file was deleted.

0 comments on commit 86698a9

Please sign in to comment.