From 63eb0d4fdf20326b70a07e2c00eab3f7ac104a4a Mon Sep 17 00:00:00 2001
From: Kostas Vilkelis <kostasvilkelis@gmail.com>
Date: Fri, 3 May 2024 15:55:26 +0200
Subject: [PATCH] add documentation from docstrings
---
docs/source/documentation/pymf.md | 7 +++++++
docs/source/index.md | 8 ++++++++
2 files changed, 15 insertions(+)
create mode 100644 docs/source/documentation/pymf.md
diff --git a/docs/source/documentation/pymf.md b/docs/source/documentation/pymf.md
new file mode 100644
index 0000000..d9d0456
--- /dev/null
+++ b/docs/source/documentation/pymf.md
@@ -0,0 +1,7 @@
+# Package reference
+
+```{eval-rst}
+.. automodule:: pymf
+ :members:
+ :show-inheritance:
+```
diff --git a/docs/source/index.md b/docs/source/index.md
index 7a6ab19..0acd205 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -23,6 +23,14 @@ graphene_example.md
hubbard_1d.md
```
+```{toctree}
+:hidden:
+:maxdepth: 1
+:caption: Documentation
+
+documentation/pymf.md
+```
+
## What is pymf?
## Why pymf?
--
GitLab