From 5801a1692ee48ad39b78188df09e4d7d393b1382 Mon Sep 17 00:00:00 2001 From: Dominik Date: Sun, 21 Apr 2024 13:51:38 -0700 Subject: [PATCH] add readthedocs config --- docs/source/index.rst | 2 ++ readthedocs.yaml | 15 +++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 readthedocs.yaml diff --git a/docs/source/index.rst b/docs/source/index.rst index 6a16e96b..12edbdf4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -30,6 +30,8 @@ notebooks/comparisons/paga.ipynb notebooks/comparisons/slignshot.ipynb +| + .. mdinclude:: ../../README.md .. toctree:: diff --git a/readthedocs.yaml b/readthedocs.yaml new file mode 100644 index 00000000..847f08db --- /dev/null +++ b/readthedocs.yaml @@ -0,0 +1,15 @@ +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +sphinx: + configuration: docs/source/conf.py + +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . \ No newline at end of file