From 1625207bb303c95aaae49a04d864cd9bb20d87c0 Mon Sep 17 00:00:00 2001 From: Chen Wu Date: Mon, 2 Dec 2024 16:22:29 +0800 Subject: [PATCH] docs: Fixed the documentation compilation issue on Read the Docs --- .readthedocs.yml => docs/en/.readthedocs.yml | 12 +++++++-- docs/requirements.txt | 2 +- docs/zh_CN/.readthedocs.yaml | 26 ++++++++++++++++++++ 3 files changed, 37 insertions(+), 3 deletions(-) rename .readthedocs.yml => docs/en/.readthedocs.yml (67%) create mode 100644 docs/zh_CN/.readthedocs.yaml diff --git a/.readthedocs.yml b/docs/en/.readthedocs.yml similarity index 67% rename from .readthedocs.yml rename to docs/en/.readthedocs.yml index 4179f6cb..cce68d3c 100644 --- a/.readthedocs.yml +++ b/docs/en/.readthedocs.yml @@ -10,9 +10,17 @@ formats: - htmlzip - pdf +# Set the version of Python and other tools you might need +build: + os: "ubuntu-20.04" + tools: + python: "3.6" + # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 install: - requirements: docs/setuptools.requirements.txt - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/en/conf.py diff --git a/docs/requirements.txt b/docs/requirements.txt index 9c581c35..7eca6125 100755 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -17,4 +17,4 @@ markdown>=3.0.1, <3.4.0 sphinx_markdown_tables==0.0.15 future==0.16.0 # for ../tools/gen_esp_err_to_name.py funcparserlib==1.0.0a0 - +Jinja2<3.1 diff --git a/docs/zh_CN/.readthedocs.yaml b/docs/zh_CN/.readthedocs.yaml new file mode 100644 index 00000000..475b872b --- /dev/null +++ b/docs/zh_CN/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - htmlzip + - pdf + +# Set the version of Python and other tools you might need +build: + os: "ubuntu-20.04" + tools: + python: "3.6" + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: docs/setuptools.requirements.txt + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/zh_CN/conf.py