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..b1c7bb7e --- /dev/null +++ b/documentation/conf.py @@ -0,0 +1,32 @@ +# -- 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", +} + +# Root document (Sphinx 2.0+) +root_doc = "index" + +# Backwards compatibility for older Sphinx versions +master_doc = root_doc + +# -- 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..45c2034a --- /dev/null +++ b/documentation/requirements.txt @@ -0,0 +1,4 @@ +sphinx +sphinx-rtd-theme +myst-parser +