From b8ee2a0b6de023eff241dd3a21f2174a7da3f8db Mon Sep 17 00:00:00 2001
From: houpc <houpc96@gmail.com>
Date: Thu, 31 Oct 2024 14:10:53 +0800
Subject: [PATCH] fix makedocs

---
 docs/make.jl                    |  2 ++
 docs/src/index.md               |  1 +
 docs/src/lib/utility.md         |  7 +++++++
 docs/src/manual/feynman_rule.md | 12 ++++++------
 4 files changed, 16 insertions(+), 6 deletions(-)
 create mode 100644 docs/src/lib/utility.md

diff --git a/docs/make.jl b/docs/make.jl
index da46915a..509da8cd 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -13,6 +13,7 @@ makedocs(;
         canonical="https://numericaleft.github.io/FeynmanDiagram.jl",
         assets=["assets/custom.css"]
     ),
+    checkdocs=:exports, # check only exported names within the modules
     pages=[
         "Home" => "index.md",
         "Manual" => [
@@ -29,6 +30,7 @@ makedocs(;
             "lib/GV.md",
             "lib/parquet.md",
             "lib/backend.md",
+            "lib/utility.md"
         ]
     ]
 )
diff --git a/docs/src/index.md b/docs/src/index.md
index 680935ee..28c9c4dc 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -23,6 +23,7 @@ Pages = [
     "lib/GV.md",
     "lib/parquet.md",
     "lib/backend.md",
+    "lib/utility.md",
 ]
 Depth = 2
 ```
diff --git a/docs/src/lib/utility.md b/docs/src/lib/utility.md
new file mode 100644
index 00000000..ed5f0b0a
--- /dev/null
+++ b/docs/src/lib/utility.md
@@ -0,0 +1,7 @@
+# Utility
+
+## API
+
+```@autodocs
+Modules = [FeynmanDiagram.Utility]
+```
\ No newline at end of file
diff --git a/docs/src/manual/feynman_rule.md b/docs/src/manual/feynman_rule.md
index d12dba4a..981225f7 100644
--- a/docs/src/manual/feynman_rule.md
+++ b/docs/src/manual/feynman_rule.md
@@ -81,9 +81,9 @@ G = g - g\Sigma g + g\Sigma g \Sigma g - ...
 ## Perturbative Expansion of the Green's Function
 
 
-![Sign rule for the Wick contractions.](../../assets/diagrams/green0.svg#green0)
+![Sign rule for the Wick contractions.](../assets/diagrams/green0.svg)
 
-![Diagrammatic expansion of the Green's function.](../../assets/diagrams/green.svg#green)
+![Diagrammatic expansion of the Green's function.](../assets/diagrams/green.svg)
 
 The sign of a Green's function diagram is given by ``(-1)^{n_v} \xi^{n_F}``, where
 
@@ -95,7 +95,7 @@ The sign of a Green's function diagram is given by ``(-1)^{n_v} \xi^{n_F}``, whe
 From the Green's function diagrams, one can derive the __negative__ self-energy diagram,
 
 
-![Diagrammatic expansion of the self-energy.](../../assets/diagrams/sigma.svg#sigma)
+![Diagrammatic expansion of the self-energy.](../assets/diagrams/sigma.svg)
 
 ```math
 \begin{aligned}
@@ -123,7 +123,7 @@ where the indices $x, y$ could be different from diagrams to diagrams, and $\Gam
 \Sigma_{3, x} -\Sigma^{Hartree}_{3, x} = G_{3,y} \cdot V_{3, 4} \cdot \Gamma^3_{4,y,x},
 ```
 
-![Diagrammatic expansion of the 3-point vertex function.](../../assets/diagrams/gamma3.svg#gamma3)
+![Diagrammatic expansion of the 3-point vertex function.](../assets/diagrams/gamma3.svg)
 
 The diagram weights are given by,
 
@@ -146,7 +146,7 @@ The 4-point vertex function is related to the 3-point vertex function through an
 
 where the indices $x, y, s, t$ could be different from diagrams to diagrams.
 
-![Diagrammatic expansion of the 4-point vertex function.](../../assets/diagrams/gamma4.svg#gamma4)
+![Diagrammatic expansion of the 4-point vertex function.](../assets/diagrams/gamma4.svg)
 
 The diagram weights are given by,
 
@@ -169,7 +169,7 @@ The susceptibility can be derived from ``\Gamma^{(4)}``.
 \chi_{1,2} \equiv \left<\mathcal{T} n_1 n_2\right>_{\text{connected}} = \xi G_{1,2} G_{2, 1} + \xi G_{1,s} G_{t, 1} \Gamma^{(4)}_{s, t, y, x} G_{2,y} G_{x, 2}
 ```
 
-![Diagrammatic expansion of the susceptibility.](../../assets/diagrams/susceptibility.svg#susceptibility)
+![Diagrammatic expansion of the susceptibility.](../assets/diagrams/susceptibility.svg)
 
 We define the polarization ``P`` as the one-interaction irreducible (or proper) vertex function,