From 69f26c91f8088737da89e714b03808be0dac96a7 Mon Sep 17 00:00:00 2001 From: Hailin Wang Date: Tue, 19 Dec 2023 09:36:08 +0800 Subject: [PATCH 1/3] Add explicit readthedocs config file --- .readthedocs.yaml | 19 +++++++++++++++++++ documentation/requirements.txt | 9 +++++++++ 2 files changed, 28 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 documentation/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..24ee80a3 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +# 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-22.04 + tools: + python: "2.7" + +sphinx: + configuration: documentation/conf.py + +formats: + - all + +python: + install: + - requirements: documentation/requirements.txt diff --git a/documentation/requirements.txt b/documentation/requirements.txt new file mode 100644 index 00000000..3acd3cb2 --- /dev/null +++ b/documentation/requirements.txt @@ -0,0 +1,9 @@ +pillow +mock==1.0.1 +alabaster>=0.7,<0.8,!=0.7.5 +commonmark==0.9.1 +recommonmark==0.5.0 +sphinx<2 +sphinx-rtd-theme<0.5 +readthedocs-sphinx-ext<2.3 +jinja2<3.1.0 From c8fe0a867075236f1d6701ed0c79ccc1f6117e7a Mon Sep 17 00:00:00 2001 From: Sergey Lyskov <3302736+lyskov@users.noreply.github.com> Date: Wed, 20 Dec 2023 12:47:48 -0700 Subject: [PATCH 2/3] dummy changes to trigger the build --- documentation/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/requirements.txt b/documentation/requirements.txt index 3acd3cb2..6e927160 100644 --- a/documentation/requirements.txt +++ b/documentation/requirements.txt @@ -7,3 +7,4 @@ sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 + From 85d6827199e52a4ea918ecf6c5eb835612855f4d Mon Sep 17 00:00:00 2001 From: Hailin Wang Date: Thu, 21 Dec 2023 09:31:05 +0800 Subject: [PATCH 3/3] Update export formats --- .readthedocs.yaml | 3 +-- documentation/requirements.txt | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 24ee80a3..90257c1c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,8 +11,7 @@ build: sphinx: configuration: documentation/conf.py -formats: - - all +formats: all python: install: diff --git a/documentation/requirements.txt b/documentation/requirements.txt index 6e927160..3acd3cb2 100644 --- a/documentation/requirements.txt +++ b/documentation/requirements.txt @@ -7,4 +7,3 @@ sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 -