docs: migrate to zensical

Author: flaport

CHANGELOG.md

@@ -28,7 +28,7 @@ This will include [gdsfactory](https://github.com/gdsfactory/gdsfactory) depende
 ## Documentation
 
 The documentation is available at
-[flaport.github.io/meow](https://flaport.github.io/meow/).
+[gdsfactory.github.io/meow](https://gdsfactory.github.io/meow/).
 
 
 ## Contributors

README.md

@@ -0,0 +1,10 @@
+document$.subscribe(({ body }) => {
+  renderMathInElement(body, {
+    delimiters: [
+      { left: "$$", right: "$$", display: true },
+      { left: "$", right: "$", display: false },
+      { left: "\\(", right: "\\)", display: false },
+      { left: "\\[", right: "\\]", display: true },
+    ],
+  });
+});

docs/javascripts/katex.js

@@ -29,10 +29,10 @@ test: ipykernel
 docs:
   sed 's|](docs/|](|g' README.md > docs/index.md
   sed 's|^#|###|g' CHANGELOG.md | sed 's|^### \[0|## [0|g' > docs/changelog.md
-  uv run mkdocs build
+  uv run zensical build
 
 serve: docs
-  uv run mkdocs serve -a localhost:8080
+  uv run zensical serve
 
 nbrun: ipykernel
   find notebooks -maxdepth 2 -mindepth 1 -name "*.ipynb" -not -path "*/.ipynb_checkpoints/*" -not -path "./.venv/*" | xargs parallel -j `nproc --all` uv run papermill {} {} -k meow :::

justfile

@@ -12,10 +12,7 @@ dev = [
   "ipympl>=0.9.0",
   "ipywidgets>=8.0.0",
   "mkautodoc>=0.2.0",
-  "mkdocs-autorefs>=1.3.0",
-  "mkdocs-shadcn @ git+https://github.com/gdsfactory/mkdocs-shadcn.git",
-  "mkdocs<2",
-  "mkdocstrings[python]>=0.27.0",
+  "mkdocstrings-python>=2.0.3",
   "mkinit>=1.1.0",
   "nb-clean>=4.0.1",
   "nbconvert>=7.16.6",
@@ -29,7 +26,8 @@ dev = [
   "ruff>=0.15.5",
   "tmm>=0.2.0",
   "towncrier>=24.0.0",
-  "ty==0.0.26"
+  "ty==0.0.26",
+  "zensical>=0.0.11"
 ]
 
 [project]

mkdocs.yml

@@ -204,6 +204,6 @@ def _assert_default_mesh_setting(condition: bool, param_name: str) -> None:  # n
         msg = (
             f"Setting mesh.{param_name} is currently not supported in the "
             "Lumerical Backend. Please open an issue of submit a PR on GitHub "
-            "to fix this: https://github.com/flaport/meow",
+            "to fix this: https://github.com/gdsfactory/meow",
         )
         raise NotImplementedError(msg)

pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+copyright = "Copyright (c) 2025, Floris Laporte, Apache-2.0"
+dev_addr = "localhost:8080"
+extra_css = [
+  "https://unpkg.com/katex@0/dist/katex.min.css"
+]
+extra_javascript = [
+  "javascripts/katex.js",
+  "https://unpkg.com/katex@0/dist/katex.min.js",
+  "https://unpkg.com/katex@0/dist/contrib/auto-render.min.js"
+]
+nav = [
+  {"home" = "index.md"},
+  {"quickstart" = "nbs/00_introduction.md"},
+  {"examples" = [
+    {"from gds" = "nbs/01_gds_taper.md"},
+    {"taper length sweep" = "nbs/02_taper_length_sweep.md"},
+    {"different modes" = "nbs/03_unequal_number_of_modes.md"},
+    {"rib interface" = "nbs/04_rib_interface.md"},
+    {"mode propagation" = "nbs/05_propagate_modes.md"}
+  ]},
+  {"algorithm" = "algorithm.md"},
+  {"api" = "api.md"},
+  {"changelog" = "changelog.md"}
+]
+repo_name = "gdsfactory/meow"
+repo_url = "https://github.com/gdsfactory/meow"
+site_author = "Floris Laporte"
+site_description = "Modeling of Eigenmodes and Overlaps in Waveguides"
+site_name = "meow"
+site_url = "https://gdsfactory.github.io/meow"
+
+[project.markdown_extensions.pymdownx.arithmatex]
+generic = true
+
+[project.plugins.mkdocstrings.handlers.python]
+inventories = [
+  "https://docs.jax.dev/en/latest/objects.inv",
+  "https://docs.kidger.site/jaxtyping/objects.inv",
+  "https://docs.python.org/3/objects.inv",
+  "https://docs.xarray.dev/en/stable/objects.inv",
+  "https://matplotlib.org/stable/objects.inv",
+  "https://numpy.org/doc/stable/objects.inv",
+  "https://pandas.pydata.org/docs/objects.inv",
+  "https://python-markdown.github.io/objects.inv",
+  "https://scipy.github.io/devdocs/objects.inv",
+  "https://typing.readthedocs.io/en/latest/objects.inv",
+  "https://www.mkdocs.org/objects.inv"
+]
+paths = [
+  "src"
+]
+
+[project.theme]
+favicon = "assets/logo-small.ico"
+logo = "assets/logo-small.svg"