From d12d6a2018473c75df4d82d83a696f26789db8d6 Mon Sep 17 00:00:00 2001 From: Luca Foppiano Date: Thu, 24 Aug 2023 10:31:54 +0900 Subject: [PATCH] fix readthedocs build (#1040) to support the new requirements --- doc/requirements.txt | 1 + mkdocs.yml | 2 +- readthedocs.yml | 20 ++++++++++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 doc/requirements.txt create mode 100644 readthedocs.yml diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..6f425d53f7 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1 @@ +mkdocs==1.5.1 diff --git a/mkdocs.yml b/mkdocs.yml index 97948c3875..f0e256fb10 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ plugins: - search theme: name: readthedocs -pages: +nav: - Home: 'index.md' - About: - 'Introduction': 'Introduction.md' diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 0000000000..a03262ecba --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: doc/requirements.txt + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false