first draft docu with sphinx html

This commit is contained in:
ortizcruz
2023-08-31 08:48:46 +02:00
parent f0d7e25ecd
commit 2bf275b335
62 changed files with 18963 additions and 0 deletions
+7
View File
@@ -0,0 +1,7 @@
app module
==========
.. automodule:: app
:members:
:undoc-members:
:show-inheritance:
+21
View File
@@ -0,0 +1,21 @@
autotranscript.app package
==========================
Submodules
----------
autotranscript.app.qtfaststart module
-------------------------------------
.. automodule:: autotranscript.app.qtfaststart
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: autotranscript.app
:members:
:undoc-members:
:show-inheritance:
+77
View File
@@ -0,0 +1,77 @@
autotranscript package
======================
Subpackages
-----------
.. toctree::
:maxdepth: 4
autotranscript.app
Submodules
----------
autotranscript.audio module
---------------------------
.. automodule:: autotranscript.audio
:members:
:undoc-members:
:show-inheritance:
autotranscript.autotranscript module
------------------------------------
.. automodule:: autotranscript.autotranscript
:members:
:undoc-members:
:show-inheritance:
autotranscript.diarisation module
---------------------------------
.. automodule:: autotranscript.diarisation
:members:
:undoc-members:
:show-inheritance:
autotranscript.misc module
--------------------------
.. automodule:: autotranscript.misc
:members:
:undoc-members:
:show-inheritance:
autotranscript.transcriber module
---------------------------------
.. automodule:: autotranscript.transcriber
:members:
:undoc-members:
:show-inheritance:
autotranscript.transcript\_exporter module
------------------------------------------
.. automodule:: autotranscript.transcript_exporter
:members:
:undoc-members:
:show-inheritance:
autotranscript.version module
-----------------------------
.. automodule:: autotranscript.version
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: autotranscript
:members:
:undoc-members:
:show-inheritance:
+7
View File
@@ -0,0 +1,7 @@
gradio\_app module
==================
.. automodule:: gradio_app
:members:
:undoc-members:
:show-inheritance:
+27
View File
@@ -0,0 +1,27 @@
.. AutoTranscript documentation master file, created by
sphinx-quickstart on Thu Aug 31 08:17:31 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to AutoTranscript's documentation!
==========================================
`AutoTranscript`: Fully Automated Transcription using AI
`AutoTranscript` is a PyTorch based interface speech-to-text tool to generate fully automated transcriptions. AutoTranscript uses AI models containing speaker diarization models:
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
+12
View File
@@ -0,0 +1,12 @@
autotranscript
==============
.. toctree::
:maxdepth: 4
app
autotranscript
gradio_app
setup
test_autotranscript
transcribe
+7
View File
@@ -0,0 +1,7 @@
setup module
============
.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:
+7
View File
@@ -0,0 +1,7 @@
test\_autotranscript module
===========================
.. automodule:: test_autotranscript
:members:
:undoc-members:
:show-inheritance:
+7
View File
@@ -0,0 +1,7 @@
transcribe module
=================
.. automodule:: transcribe
:members:
:undoc-members:
:show-inheritance: