From ce26cad5c447fe82be84414d0ee20a7a13928ab5 Mon Sep 17 00:00:00 2001
From: Kostas Vilkelis <kostasvilkelis@gmail.com>
Date: Tue, 7 May 2024 23:59:49 +0200
Subject: [PATCH] move tutorials to dedicated folder
---
docs/source/{ => documentation}/algorithm.md | 12 ++++++++++++
docs/source/{ => documentation}/mf_notes.md | 12 ++++++++++++
docs/source/index.md | 12 ++++--------
docs/source/{ => tutorial}/graphene_example.md | 0
docs/source/{ => tutorial}/hubbard_1d.md | 0
5 files changed, 28 insertions(+), 8 deletions(-)
rename docs/source/{ => documentation}/algorithm.md (91%)
rename docs/source/{ => documentation}/mf_notes.md (94%)
rename docs/source/{ => tutorial}/graphene_example.md (100%)
rename docs/source/{ => tutorial}/hubbard_1d.md (100%)
diff --git a/docs/source/algorithm.md b/docs/source/documentation/algorithm.md
similarity index 91%
rename from docs/source/algorithm.md
rename to docs/source/documentation/algorithm.md
index 3845eab..b575d86 100644
--- a/docs/source/algorithm.md
+++ b/docs/source/documentation/algorithm.md
@@ -1,3 +1,15 @@
+---
+jupytext:
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.14.4
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
# Algorithm overview
## Self-consistency loop
diff --git a/docs/source/mf_notes.md b/docs/source/documentation/mf_notes.md
similarity index 94%
rename from docs/source/mf_notes.md
rename to docs/source/documentation/mf_notes.md
index 33d49dd..8c8d063 100644
--- a/docs/source/mf_notes.md
+++ b/docs/source/documentation/mf_notes.md
@@ -1,3 +1,15 @@
+---
+jupytext:
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.14.4
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
# Theory overview
## Interacting problems
diff --git a/docs/source/index.md b/docs/source/index.md
index 5bc8c55..4ca49e0 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -18,12 +18,8 @@ kernelspec:
:maxdepth: 1
:caption: Tutorials
-
-mf_notes.md
-algorithm.md
-hubbard_1d.md
-graphene_example.md
-
+tutorial/hubbard_1d.md
+tutorial/graphene_example.md
```
```{toctree}
@@ -31,8 +27,8 @@ graphene_example.md
:maxdepth: 1
:caption: Documentation
-mf_notes.md
-algorithm.md
+documentation/mf_notes.md
+documentation/algorithm.md
documentation/pymf.md
```
diff --git a/docs/source/graphene_example.md b/docs/source/tutorial/graphene_example.md
similarity index 100%
rename from docs/source/graphene_example.md
rename to docs/source/tutorial/graphene_example.md
diff --git a/docs/source/hubbard_1d.md b/docs/source/tutorial/hubbard_1d.md
similarity index 100%
rename from docs/source/hubbard_1d.md
rename to docs/source/tutorial/hubbard_1d.md
--
GitLab