FIX: bring back the page structure in old user guide documentation

AaltoRSE · Jun 17, 2024 · 15348b1 · 15348b1
1 parent 5744940
commit 15348b1
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/docs/source/for_developers.rst b/docs/source/for_developers.rst
@@ -0,0 +1,4 @@
+For developers
+==============
+
+For details on the app implementation and setup on the Aalto Triton cluster, see `the GitHub repo and the README.md <https://github.com/aaltorse/speech2text#speech2text>`_.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,3 +1,18 @@
-The Aalto speech2text user guide has been moved to Aalto Triton documentation: 
+.. speech2text documentation master file, created by
+   sphinx-quickstart on Mon Aug  7 11:49:17 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Aalto speech2text's documentation!
+=============================================
+
+Aalto speech2text is a speech recognition and diarization (speaker detection) app available to researchers of Aalto University.
+The list of supported languages can be found `here <https://github.com/openai/whisper#available-models-and-languages>`_.
+The app is run on Aalto Triton cluster and its usage is free for Aalto researchers.
+
+.. toctree::
+   :maxdepth: 2
+
+   User Guide <user_guide.rst>
+   For developers <for_developers.rst>
 
-`<https://scicomp.aalto.fi/triton/apps/speech2text/>`__
diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md
@@ -0,0 +1,8 @@
+# User Guide
+
+The Aalto speech2text user guide can now be found under the Aalto Triton documentation: 
+
+[https://scicomp.aalto.fi/triton/apps/speech2text/](https://scicomp.aalto.fi/triton/apps/speech2text/)
+
+
+