From 6f6cf8dd0d5a6a0cacabeb4576a28d22c005db69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mose=20M=C3=BCller?= Date: Tue, 19 Sep 2023 16:06:33 +0200 Subject: [PATCH] feat: adds readthedocs config file --- .readthedocs.yaml | 21 +++++++++++++++++++++ docs/requirements.txt | 20 ++++++++++++++++++++ 2 files changed, 41 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..1ec181b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,21 @@ +# Read the Docs configuration file for MkDocs projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +mkdocs: + configuration: mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - method: pip + path: . + - 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..ce8573d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,20 @@ +click==8.1.7 ; python_version >= "3.10" and python_version < "4.0" +colorama==0.4.6 ; python_version >= "3.10" and python_version < "4.0" and platform_system == "Windows" +ghp-import==2.1.0 ; python_version >= "3.10" and python_version < "4.0" +jinja2==3.1.2 ; python_version >= "3.10" and python_version < "4.0" +markdown==3.4.4 ; python_version >= "3.10" and python_version < "4.0" +markupsafe==2.1.3 ; python_version >= "3.10" and python_version < "4.0" +mergedeep==1.3.4 ; python_version >= "3.10" and python_version < "4.0" +mkdocs-autorefs==0.5.0 ; python_version >= "3.10" and python_version < "4.0" +mkdocs-include-markdown-plugin==3.9.1 ; python_version >= "3.10" and python_version < "4.0" +mkdocs==1.5.3 ; python_version >= "3.10" and python_version < "4.0" +mkdocstrings==0.22.0 ; python_version >= "3.10" and python_version < "4.0" +packaging==23.1 ; python_version >= "3.10" and python_version < "4.0" +pathspec==0.11.2 ; python_version >= "3.10" and python_version < "4.0" +platformdirs==3.10.0 ; python_version >= "3.10" and python_version < "4.0" +pymdown-extensions==10.3 ; python_version >= "3.10" and python_version < "4.0" +python-dateutil==2.8.2 ; python_version >= "3.10" and python_version < "4.0" +pyyaml-env-tag==0.1 ; python_version >= "3.10" and python_version < "4.0" +pyyaml==6.0.1 ; python_version >= "3.10" and python_version < "4.0" +six==1.16.0 ; python_version >= "3.10" and python_version < "4.0" +watchdog==3.0.0 ; python_version >= "3.10" and python_version < "4.0"