aboutsummaryrefslogtreecommitdiff
path: root/doc_generator/index.rst
diff options
context:
space:
mode:
authorEugeniy E. Mikhailov <evgmik@gmail.com>2024-06-27 23:42:33 -0400
committerEugeniy E. Mikhailov <evgmik@gmail.com>2024-06-27 23:42:33 -0400
commit8756a5e023bd99d0358e1e2c70cedaa47e416d6d (patch)
tree10a3b49d1f6d7c3a562e5ef48992f4d8ea658030 /doc_generator/index.rst
parent19502d99b0a912f6d5221138cc4879dc916c500e (diff)
downloadqolab-8756a5e023bd99d0358e1e2c70cedaa47e416d6d.tar.gz
qolab-8756a5e023bd99d0358e1e2c70cedaa47e416d6d.zip
added infrastructure to generate Docs with sphinx
Diffstat (limited to 'doc_generator/index.rst')
-rw-r--r--doc_generator/index.rst19
1 files changed, 19 insertions, 0 deletions
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`