From b5c83e453fd95618666ec113995b1b560523751d Mon Sep 17 00:00:00 2001 From: TheOnlyWayUp Date: Fri, 2 Feb 2024 02:26:21 +0000 Subject: [PATCH] feat(docs): Add Read-The-Docs Support --- .readthedocs.yaml | 17 +++++++++++++++++ docs_requirements.txt | 7 +++++++ 2 files changed, 24 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs_requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..eb1700b --- /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 + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +mkdocs: + configuration: mkdocs.yml + +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..b399c2c --- /dev/null +++ b/docs_requirements.txt @@ -0,0 +1,7 @@ +mkdocs==1.5.3 +mkdocs-autorefs==0.5.0 +mkdocs-jupyter==0.24.6 +mkdocs-material==9.5.5 +mkdocs-material-extensions==1.3.1 +mkdocstrings==0.24.0 +mkdocstrings-python==1.8.0