Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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

32 changes: 32 additions & 0 deletions documentation/conf.py
Original file line number Diff line number Diff line change
@@ -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"]

18 changes: 18 additions & 0 deletions documentation/index.rst
Original file line number Diff line number Diff line change
@@ -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

4 changes: 4 additions & 0 deletions documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx
sphinx-rtd-theme
myst-parser

Loading