aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile20
-rw-r--r--doc_generator/conf.py46
-rw-r--r--doc_generator/index.rst19
-rw-r--r--make.bat35
4 files changed, 120 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..a25dd82
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = doc_generator
+BUILDDIR = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
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`
diff --git a/make.bat b/make.bat
new file mode 100644
index 0000000..0d4c773
--- /dev/null
+++ b/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=doc_generator
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd