From ff81d1cfa2d5dacd986034e8f875c1e99bfe3c52 Mon Sep 17 00:00:00 2001 From: "haote.yang" Date: Tue, 18 May 2021 21:58:44 +0800 Subject: [PATCH] docs: add ReadtheDocs config file .readthedocs.yaml --- .readthedocs.yaml | 17 +++++++++++++++++ docs/source/index.rst | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..0571c06a8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +--- +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + fail_on_warning: true + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.8 + install: + - requirements: requirements.txt diff --git a/docs/source/index.rst b/docs/source/index.rst index fb04a710d..d46d35cbe 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -35,7 +35,7 @@ It provides: :caption: Quick Start quick_start/getting_started_with_tensorbay - quick_start/examples + quick_start/examples_ .. toctree:: :maxdepth: 1