From a5c3ba8f56aa19ab5bcbca04b3da30579953d954 Mon Sep 17 00:00:00 2001 From: JE-Chen <33644111+JE-Chen@users.noreply.github.com> Date: Mon, 14 Aug 2023 11:28:44 +0800 Subject: [PATCH] Fix doc --- .readthedocs.yaml | 24 +++++++++++++++++++++--- docs/requirements.txt | 1 + 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e6743d9..cc771cc 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,9 +1,27 @@ -version: 2 +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -sphinx: - configuration: docs/source/conf.py +# Required +version: 2 +# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..4170c03 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme \ No newline at end of file