From e96842fefa1bde2c7301bbde0eeed8faf8efcdb7 Mon Sep 17 00:00:00 2001 From: "alvaro.gonzalez" Date: Mon, 26 Jan 2026 14:32:49 +0200 Subject: [PATCH 1/3] Add Read the docs files. Before they were auto generated --- .readthedocs.yaml | 14 ++++++++++++++ documentation/conf.py | 28 ++++++++++++++++++++++++++++ documentation/index.rst | 18 ++++++++++++++++++ documentation/requirements.txt | 14 ++++++++++++++ 4 files changed, 74 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 documentation/conf.py create mode 100644 documentation/index.rst create mode 100644 documentation/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ff8edf65 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.11" + +sphinx: + configuration: documentation/conf.py + +python: + install: + - requirements: documentation/requirements.txt + diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 00000000..e0feda28 --- /dev/null +++ b/documentation/conf.py @@ -0,0 +1,28 @@ +# -- Project information ----------------------------------------------------- + +project = "TESK" +author = "TESK contributors" + +# -- General configuration --------------------------------------------------- + +extensions = [ + "myst_parser", +] + +templates_path = ["_templates"] +exclude_patterns = [] + +# Markdown support +source_suffix = { + ".rst": "restructuredtext", + ".md": "markdown", +} + +master_doc = "index" + +# -- HTML output ------------------------------------------------------------- + +html_theme = "sphinx_rtd_theme" + +html_static_path = ["_static"] + diff --git a/documentation/index.rst b/documentation/index.rst new file mode 100644 index 00000000..5abef772 --- /dev/null +++ b/documentation/index.rst @@ -0,0 +1,18 @@ +TESK documentation +================== + +TESK (Task Execution Service for Kubernetes) provides a GA4GH-compliant +Task Execution Service implementation designed to run on Kubernetes. + +This documentation describes the architecture, deployment, and integration +options for TESK. + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + tesintro + deployment + integrated_wes_tes + local_ftp + diff --git a/documentation/requirements.txt b/documentation/requirements.txt new file mode 100644 index 00000000..ff8edf65 --- /dev/null +++ b/documentation/requirements.txt @@ -0,0 +1,14 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.11" + +sphinx: + configuration: documentation/conf.py + +python: + install: + - requirements: documentation/requirements.txt + From 510c782dafb3a4161beb248a706e31ed4c537991 Mon Sep 17 00:00:00 2001 From: Tristan <74349933+trispera@users.noreply.github.com> Date: Mon, 26 Jan 2026 14:35:21 +0200 Subject: [PATCH 2/3] Apply suggestion from @sourcery-ai[bot] Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --- documentation/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/documentation/conf.py b/documentation/conf.py index e0feda28..b1c7bb7e 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -18,7 +18,11 @@ ".md": "markdown", } -master_doc = "index" +# Root document (Sphinx 2.0+) +root_doc = "index" + +# Backwards compatibility for older Sphinx versions +master_doc = root_doc # -- HTML output ------------------------------------------------------------- From b778f925c47ef0aa3c16f96afc2c5eacfc80b693 Mon Sep 17 00:00:00 2001 From: "alvaro.gonzalez" Date: Mon, 26 Jan 2026 14:37:09 +0200 Subject: [PATCH 3/3] Ups --- documentation/requirements.txt | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/documentation/requirements.txt b/documentation/requirements.txt index ff8edf65..45c2034a 100644 --- a/documentation/requirements.txt +++ b/documentation/requirements.txt @@ -1,14 +1,4 @@ -version: 2 - -build: - os: ubuntu-24.04 - tools: - python: "3.11" - -sphinx: - configuration: documentation/conf.py - -python: - install: - - requirements: documentation/requirements.txt +sphinx +sphinx-rtd-theme +myst-parser