docs: Introduce a default .readthedocs.yaml
PATCH 1/1 docs: Introduce a default .readthedocs.yaml
Read The Docs now requires a configuration file, which is awkward when using RTD to render proposed changes on the list.
Provide the minimal configuration file possible, sacrificing all reproducibility in order to hopefully not need to touch it moving forwards.
---
CC: Anthony PERARD <[email protected]>
CC: Michal Orzel <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Julien Grall <[email protected]>
CC: Roger Pau Monné <[email protected]>
CC: Stefano Stabellini <[email protected]>
Notably, I've figured out how to get back to using rtd-theme:
https://andrewcoop-xen.readthedocs.io/en/docs-secureboot/admin-guide/uefi-secure-boot.html
and without needing a separate docs/requirements.txt file in the tree too.
--- .readthedocs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yaml
.readthedocs.yaml new file +18 -0
@@ -0,0 +1,18 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-lts-latest + + tools: + python: "latest" + + jobs: + post_install: + # Instead of needing a separate requirements.txt + - python -m pip install --upgrade --no-cache-dir sphinx-rtd-theme + +sphinx: + configuration: docs/conf.py
Signature · 1 line
2.39.5
Quoted 7 lines · Andrew Cooper
Read The Docs now requires a configuration file, which is awkward when using RTD to render proposed changes on the list.
Provide the minimal configuration file possible, sacrificing all reproducibility in order to hopefully not need to touch it moving forwards.
Signed-off-by Andrew Cooper <[email protected]>
Quoted 45 lines
---
CC: Anthony PERARD <[email protected]>
CC: Michal Orzel <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Julien Grall <[email protected]>
CC: Roger Pau Monné <[email protected]>
CC: Stefano Stabellini <[email protected]>Notably, I've figured out how to get back to using rtd-theme:
https://andrewcoop-xen.readthedocs.io/en/docs-secureboot/admin-guide/uefi-secure-boot.html
and without needing a separate
docs/requirements.txtfile in the tree too.--- .readthedocs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yaml.readthedocs.yaml new file +18
-0@@ -0,0 +1,18 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-lts-latest + + tools: + python: "latest" + + jobs: + post_install: + # Instead of needing a separate requirements.txt + - python -m pip install --upgrade --no-cache-dir sphinx-rtd-theme + +sphinx: + configuration: docs/conf.pySignature · 1 line
2.39.5