From 15348b1ad4e9bd7e0f2e48d9fbb53e3a88d4abd5 Mon Sep 17 00:00:00 2001 From: Teemu Ruokolainen Date: Mon, 17 Jun 2024 11:03:54 +0300 Subject: [PATCH] FIX: bring back the page structure in old user guide documentation --- docs/source/for_developers.rst | 4 ++++ docs/source/index.rst | 19 +++++++++++++++++-- docs/source/user_guide.md | 8 ++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 docs/source/for_developers.rst create mode 100644 docs/source/user_guide.md diff --git a/docs/source/for_developers.rst b/docs/source/for_developers.rst new file mode 100644 index 0000000..7f27acb --- /dev/null +++ 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 `_. \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index da8e96c..7875726 100644 --- 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 `_. +The app is run on Aalto Triton cluster and its usage is free for Aalto researchers. + +.. toctree:: + :maxdepth: 2 + + User Guide + For developers -``__ \ No newline at end of file diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md new file mode 100644 index 0000000..28af57b --- /dev/null +++ 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/) + + +