docs: add docstrings to plotting.colors

kmnhan · Apr 11, 2024 · 1a15a70 · 1a15a70
1 parent a70c425
commit 1a15a70
Show file tree

Hide file tree

Showing 4 changed files with 213 additions and 52 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -129,6 +129,7 @@
     "pyqtgraph": ("https://pyqtgraph.readthedocs.io/en/latest/", None),
     "csaps": ("https://csaps.readthedocs.io/en/latest/", None),
     "iminuit": ("https://scikit-hep.org/iminuit/", None),
+    "cmasher": ("https://cmasher.readthedocs.io/", None),
 }
 
 
@@ -421,7 +422,6 @@ def get_inproceedings_template(self, e):
 
 latex_engine = "lualatex"
 latex_show_pagerefs = True
-latex_show_urls = "footnote"
 latex_table_style = ["booktabs", "colorrows"]
 latex_elements = {
     "fontpkg": r"""\usepackage{fontspec,unicode-math}

diff --git a/docs/source/user-guide/plotting.ipynb b/docs/source/user-guide/plotting.ipynb
@@ -67,7 +67,8 @@
     "tags": []
    },
    "source": [
-    "First, let us generate some example data from a simple tight binding model of graphene."
+    "First, let us generate some example data from a simple tight binding model of graphene.\n",
+    "A rigid shift of 200 meV has been applied so that the Dirac cone is visible."
    ]
   },
   {
@@ -84,7 +85,7 @@
    "source": [
     "from erlab.interactive.exampledata import generate_data\n",
     "\n",
-    "dat = generate_data().T"
+    "dat = generate_data(bandshift=-0.2).T"
    ]
   },
   {

diff --git a/src/erlab/interactive/exampledata.py b/src/erlab/interactive/exampledata.py
@@ -47,7 +47,7 @@ def generate_data(
     temp: float = 20.0,
     a: float = 6.97,
     t: float = 0.43,
-    bandshift: float = -0.2,
+    bandshift: float = 0.0,
     Sreal: float = 0.0,
     Simag: float = 0.03,
     kres: float = 0.01,
@@ -77,7 +77,7 @@ def generate_data(
     t
         Tight binding parameter :math:`t`, by default 0.43
     bandshift
-        The rigid energy shift in eV, by default -0.2
+        The rigid energy shift in eV, by default 0.0
     Sreal
         The real part of the self energy, by default 0.0
     Simag
@@ -156,7 +156,7 @@ def generate_data_angles(
     temp: float = 20.0,
     a: float = 6.97,
     t: float = 0.43,
-    bandshift: float = -0.2,
+    bandshift: float = 0.0,
     Sreal: float = 0.0,
     Simag: float = 0.03,
     angres: float = 0.1,
@@ -191,7 +191,7 @@ def generate_data_angles(
     t
         Tight binding parameter :math:`t`, by default 0.43
     bandshift
-        The rigid energy shift in eV, by default -0.2
+        The rigid energy shift in eV, by default 0.0
     Sreal
         The real part of the self energy, by default 0.0
     Simag