From c37d57804c9de6426b96760b8db4968fe7783fd1 Mon Sep 17 00:00:00 2001 From: Markus Vieth Date: Sat, 18 Nov 2023 14:34:22 +0100 Subject: [PATCH] Add readthedocs config files Readthedocs now requires special config files: https://blog.readthedocs.com/migrate-configuration-v2/ The builds on rtd have been failing since end of September because we do not have them yet. Also add a rtd batch in our main README so we notice failing builds sooner. --- README.md | 1 + doc/advanced/.readthedocs.yaml | 22 ++++++++++++++++++++++ doc/tutorials/.readthedocs.yaml | 22 ++++++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 doc/advanced/.readthedocs.yaml create mode 100644 doc/tutorials/.readthedocs.yaml diff --git a/README.md b/README.md index 836ca00c1ae..75482dc411a 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ Ubuntu | [![Status][ci-ubuntu-20.04]][ci-latest-build]
[! Windows | [![Status][ci-windows-x86]][ci-latest-build]
[![Status][ci-windows-x64]][ci-latest-build] | macOS | [![Status][ci-macos-12]][ci-latest-build]
[![Status][ci-macos-13]][ci-latest-build] | Documentation | [![Status][ci-docs]][ci-latest-docs] | +Read the Docs | [![Documentation Status](https://readthedocs.org/projects/pcl-tutorials/badge/?version=master)](https://pcl.readthedocs.io/projects/tutorials/en/master/?badge=master) | Community --------- diff --git a/doc/advanced/.readthedocs.yaml b/doc/advanced/.readthedocs.yaml new file mode 100644 index 00000000000..c8d6adf3b64 --- /dev/null +++ b/doc/advanced/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +sphinx: + configuration: doc/advanced/content/conf.py + +formats: + - epub + - pdf + +python: + install: + - requirements: doc/requirements.txt diff --git a/doc/tutorials/.readthedocs.yaml b/doc/tutorials/.readthedocs.yaml new file mode 100644 index 00000000000..e0ee8c8a34d --- /dev/null +++ b/doc/tutorials/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +sphinx: + configuration: doc/tutorials/content/conf.py + +formats: + - epub + - pdf + +python: + install: + - requirements: doc/requirements.txt