add sphinx docs

This commit is contained in:
makaveli10
2023-09-22 12:28:31 +05:30
parent b617b03077
commit 96e86f2c7a
26 changed files with 3723 additions and 0 deletions
+36
View File
@@ -0,0 +1,36 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
project = 'whisper_live'
copyright = '2023, Collabora'
author = 'Collabora'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
]
+25
View File
@@ -0,0 +1,25 @@
.. whisper_live documentation master file, created by
sphinx-quickstart on Fri Sep 22 11:39:30 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to whisper_live's documentation!
========================================
.. toctree::
:maxdepth: 2
.. automodule:: whisper_live.server
:members:
.. automodule:: whisper_live.client
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`