diff options
Diffstat (limited to 'doc_generator')
-rw-r--r-- | doc_generator/conf.py | 46 | ||||
-rw-r--r-- | doc_generator/index.rst | 19 |
2 files changed, 65 insertions, 0 deletions
diff --git a/doc_generator/conf.py b/doc_generator/conf.py new file mode 100644 index 0000000..ea25871 --- /dev/null +++ b/doc_generator/conf.py @@ -0,0 +1,46 @@ +# 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 +import sys +import os + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'qolab' +copyright = '2024, qolab developers' +author = 'Eugeniy Mikhailov' +release = '1.14' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'autoapi.extension', + # 'sphinx.ext.autodoc', + # 'sphinx.ext.autosummary', + # 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', + 'sphinx_rtd_theme'] +# extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary'] +autoapi_dirs = ['../qolab'] + +templates_path = ['_templates'] +exclude_patterns = [] + +sys.path.insert(0, os.path.abspath('..')) +# autosummary_generate = True +autosummary_mock_imports = ['pandas', 'universal_tsdb', 'justpy', 'ue9', 'cachetools'] + +napoleon_google_docstring = True +napoleon_numpy_docstring = True + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +# html_theme = 'alabaster' +# html_theme = 'sphinx_rtd_theme' +html_theme = 'furo' +html_static_path = ['_static'] diff --git a/doc_generator/index.rst b/doc_generator/index.rst new file mode 100644 index 0000000..ecc8a54 --- /dev/null +++ b/doc_generator/index.rst @@ -0,0 +1,19 @@ +.. qolab documentation master file, created by + sphinx-quickstart on Tue Jun 25 20:01:03 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to qolab's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |