Add preliminary sphinx documentation

2026-09-11 12:00:24 +08:00 · 2021-06-28 17:03:47 +02:00
parent 6b265ae8e3
commit 65958eaa41
27 changed files with 1200 additions and 198 deletions
@@ -0,0 +1,40 @@
+
+```{include} ../../README.md
+:relative-images:
+```
+
+----
+
+# Documentation Content
+```{eval-rst}
+.. toctree::
+    :maxdepth: 2
+    :caption: Get started
+
+    tutorial_for_nervous_beginners
+    installation
+    faq
+    contributing
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Using 🐸TTS
+
+    inference
+    implementing_a_new_model
+    training_a_model
+    configuration
+    formatting_your_dataset
+    what_makes_a_good_dataset
+    tts_datasets
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Main Classes
+
+    trainer_api
+    audio_processor
+    model_api
+    configuration
+    dataset
+```