add docs

elixir-cloud-aai · Jun 8, 2024 · b879d6b · b879d6b
1 parent d1ace7c
commit b879d6b
Show file tree

Hide file tree

Showing 6 changed files with 96 additions and 3 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,7 +19,7 @@ Package contents
 
 .. toctree::
    :maxdepth: 2
-   :caption: package
+   :caption: API referance
 
    pages/tesk/modules
 

diff --git a/docs/source/pages/tesk/modules.rst b/docs/source/pages/tesk/modules.rst
@@ -1,7 +1,14 @@
-tesk
+TESK
 ====
 
 .. toctree::
    :maxdepth: 4
+   :caption: Services (filer and taskmaster)
 
-   tesk
+   tesk.services
+
+.. toctree::
+   :maxdepth: 4
+   :caption: API
+
+   tesk.api
diff --git a/docs/source/pages/tesk/tesk.api.ga4gh.rst b/docs/source/pages/tesk/tesk.api.ga4gh.rst
@@ -0,0 +1,18 @@
+tesk.api.ga4gh package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tesk.api.ga4gh.tes
+
+Module contents
+---------------
+
+.. automodule:: tesk.api.ga4gh
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/tesk/tesk.api.ga4gh.tes.base.rst b/docs/source/pages/tesk/tesk.api.ga4gh.tes.base.rst
@@ -0,0 +1,21 @@
+tesk.api.ga4gh.tes.base package
+===============================
+
+Submodules
+----------
+
+tesk.api.ga4gh.tes.base.base\_tesk\_request module
+--------------------------------------------------
+
+.. automodule:: tesk.api.ga4gh.tes.base.base_tesk_request
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tesk.api.ga4gh.tes.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/tesk/tesk.api.ga4gh.tes.rst b/docs/source/pages/tesk/tesk.api.ga4gh.tes.rst
@@ -0,0 +1,29 @@
+tesk.api.ga4gh.tes package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tesk.api.ga4gh.tes.base
+
+Submodules
+----------
+
+tesk.api.ga4gh.tes.controllers module
+-------------------------------------
+
+.. automodule:: tesk.api.ga4gh.tes.controllers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tesk.api.ga4gh.tes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/tesk/tesk.api.rst b/docs/source/pages/tesk/tesk.api.rst
@@ -0,0 +1,18 @@
+tesk.api package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tesk.api.ga4gh
+
+Module contents
+---------------
+
+.. automodule:: tesk.api
+   :members:
+   :undoc-members:
+   :show-inheritance: