ENH: webpage redesign

.github/workflows/ci-docs.yml

@@ -3,6 +3,8 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: |-
     ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+env:
+  FORCE_COLOR: 1
 on:
   pull_request:
     branches: [main]

docs/branching-fraction.md

@@ -1,4 +1,4 @@
-# Branching fraction tables
+# Branching fractions
 
 From [PDG Live](https://pdglive.lbl.gov).
 

docs/conf.py

@@ -1,5 +1,9 @@
 import os
 
+ORGANIZATION = "ComPWA"
+REPO_NAME = "gluex-nstar"
+
+author = "ComPWA"
 comments_config = {
     "hypothesis": True,
 }
@@ -16,8 +20,57 @@
     "sphinx_comments",
     "sphinx_copybutton",
 ]
+html_logo = (
+    "https://github.com/user-attachments/assets/5650480b-8bed-4fb2-9f2b-c43b12e16ac3"
+)
+html_favicon = "_static/favicon.ico"
 html_theme = "sphinx_book_theme"
-master_doc = "index"
+html_theme_options = {
+    "announcement": "⚠️ This repository is under active development ⚠️",
+    "icon_links": [
+        {
+            "name": "Common Partial Wave Analysis",
+            "url": "https://compwa.github.io",
+            "icon": "_static/favicon.ico",
+            "type": "local",
+        },
+        {
+            "name": "GitHub",
+            "url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "Launch on Binder",
+            "url": f"https://mybinder.org/v2/gh/{ORGANIZATION}/{REPO_NAME}/main?filepath=docs",
+            "icon": "https://mybinder.readthedocs.io/en/latest/_static/favicon.png",
+            "type": "url",
+        },
+        {
+            "name": "Launch on Colaboratory",
+            "url": f"https://colab.research.google.com/github/{ORGANIZATION}/{REPO_NAME}/blob/main",
+            "icon": "https://avatars.githubusercontent.com/u/33467679?s=100",
+            "type": "url",
+        },
+    ],
+    "launch_buttons": {
+        "binderhub_url": "https://mybinder.org",
+        "colab_url": "https://colab.research.google.com",
+        "deepnote_url": "https://deepnote.com",
+        "notebook_interface": "jupyterlab",
+    },
+    "logo": {"text": "Symbolic Amplitudes<br>for Light Baryons"},
+    "path_to_docs": "docs",
+    "repository_branch": "main",
+    "repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
+    "show_navbar_depth": 2,
+    "show_toc_level": 2,
+    "use_download_button": False,
+    "use_edit_page_button": True,
+    "use_issues_button": True,
+    "use_repository_button": True,
+    "use_source_button": True,
+}
+html_title = "GlueX Symbolic N* Amplitudes"
 myst_enable_extensions = [
     "amsmath",
     "colon_fence",

docs/ampform/etapi0p.ipynb → docs/eta-pi-p/automated.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# pγ→ηπ⁰p amplitude model"
+    "# Amplitude model with `ampform`"
    ]
   },
   {

docs/eta-pi-p/index.md

@@ -0,0 +1,25 @@
+# pγ → ηπ⁰p
+
+## Amplitude Analysis 101 / PWA101 (v2.0)
+
+### CAS-assisted Amplitude Models building for photoproduction reaction
+
+This document is a follow-up of PWA101 (v1.0) (temporarily see [here](https://compwa--217.org.readthedocs.build/report/999.html)),
+as an introduction to Amplitude Analysis / Partial Wave Analysis (PWA) by demonstrating its application to a specific reaction channel and amplitude model.
+
+Now the focus is the use of symbolic expressions (computations), with the use of [ComPWA packages](https://compwa.github.io/), or CAS(Computer Algebra System)-assisted model building in general (the python package `SymPy` in this case) to illustrate the general process in PWA.
+
+This tutorial aims to equip readers with deeper understanding of PWA methodologies and full workflow in the context of hadron physics through a practical, hands-on example with symbolic expressions via [ComPWA](https://compwa.github.io/).
+
+Furthermore,
+address to the issue ✅ [ComPWA/gluex-nstar#1](https://github.com/ComPWA/gluex-nstar/issues/1), this document is PWA101(v2.0), which shows PWA methodologies and full workflow in the context of hadron physics with symbolic expressions via [ComPWA](https://compwa.github.io/).
+
+In the following, an attempt to manually formulate the amplitude model via Sympy is shown.
+Later on, attempts of automated amplitude model formualtion are done via e.g. `ampform` and `ampform-dpd`.
+
+```{toctree}
+reaction-model
+pgamma-state
+manual
+automated
+```

docs/symbolics.ipynb → docs/eta-pi-p/manual.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# pγ→ηπ⁰p with SymPy only"
+    "# Amplitude model with `sympy`"
    ]
   },
   {

docs/pgamma-state.ipynb → docs/eta-pi-p/pgamma-state.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# $p \\gamma \\to \\eta \\pi^0 p$ reaction via `QRules`"
+    "# Reaction via `qrules`"
    ]
   },
   {

docs/index.md

@@ -1,24 +1,21 @@
-# Amplitude Analysis 101 / PWA101 (v2.0)
+# Symbolic Amplitude Models with $N^*$ Resonances at GlueX
 
-## CAS-assisted Amplitude Models building for photoproduction reaction
+:::{title} Welcome
+:::
 
-This document is a follow-up of PWA101 (v1.0) (temporarily see [here](https://compwa--217.org.readthedocs.build/report/999.html)),
-as an introduction to Amplitude Analysis / Partial Wave Analysis (PWA) by demonstrating its application to a specific reaction channel and amplitude model.
+We are doing amplitude analysis and Partial Wave Analysis (PWA) with [CAS-assisted model building](https://compwa.github.io/symbolics), which is a technique employed in the ComPWA project.
 
-Now the focus is the use of symbolic expressions (computations), with the use of [ComPWA packages](https://compwa.github.io/), or CAS(Computer Algebra System)-assisted model building in general (the python package `SymPy` in this case) to illustrate the general process in PWA.
+- One demonstration example is:<br>
+  $p \gamma \to$ Resonances (e.g. N\*) $\to \eta \pi^0 p$
+- The main focus of this research would be:<br>
+  $p \gamma \to$ Resonances (e.g. N\*, K\*) $\to K^+ \pi^0 \Lambda$
 
-This tutorial aims to equip readers with deeper understanding of PWA methodologies and full workflow in the context of hadron physics through a practical, hands-on example with symbolic expressions via [ComPWA](https://compwa.github.io/).
-
-Furthermore,
-address to the issue ✅&nbsp;[ComPWA/gluex-nstar#1](https://github.com/ComPWA/gluex-nstar/issues/1), this document is PWA101(v2.0), which shows PWA methodologies and full workflow in the context of hadron physics with symbolic expressions via [ComPWA](https://compwa.github.io/).
-
-# Table of contents:
+This research project focuses on developing and applying amplitude models to analyze data from the GlueX experiment, specifically targeting $N^*$ and $K^*$ resonances.
 
 ```{toctree}
-reaction
-symbolics
-pgamma-state
+:caption: Table of contents
+:maxdepth: 2
 branching-fraction
-ampform/etapi0p
-ampform/LambdaKpi0
+lambda-k-pi/index
+eta-pi-p/index
 ```

docs/ampform/LambdaKpi0.ipynb → docs/lambda-k-pi/automated.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# pγ → ΛK⁺π⁰ amplitude model"
+    "# Amplitude model with `ampform`"
    ]
   },
   {
@@ -610,7 +610,8 @@
      "source_hidden": true
     },
     "tags": [
-     "hide-input"
+     "hide-input",
+     "full-width"
     ]
    },
    "outputs": [],

docs/lambda-k-pi/index.md

@@ -0,0 +1,5 @@
+# pγ → ΛK⁺π⁰
+
+```{toctree}
+automated
+```

pyproject.toml

@@ -101,9 +101,11 @@ preview = true
 
 [tool.ruff.lint]
 ignore = [
+    "COM812",
     "CPY001",
     "D203",
     "D213",
+    "ISC001",
 ]
 preview = true
 select = ["ALL"]