PyFiberModes 0.17.3__tar.gz → 0.17.4__tar.gz

pyfibermodes-0.17.4/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,40 @@
+name: Publish documentation
+
+on:
+  push:
+    branches: [master]
+    tags: ["v*"]
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  documentation:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      python-version: "3.11"
+      package-name: PyFiberModes
+      apt-package: xvfb jq
+
+  maintain_documentation:
+    needs: documentation
+    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install documentation landing page
+        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          ref: documentation_page
+          fetch-depth: 0
+      - run: |
+          set -Eeuo pipefail
+          git show "${GITHUB_SHA}:docs/redirect.html" > index.html
+          test -s docs/latest/index.html
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add index.html
+          if git diff --cached --quiet; then exit 0; fi
+          git commit -m "Update documentation landing page [skip ci]"
+          git push origin HEAD:documentation_page

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/.gitignore

@@ -34,6 +34,7 @@
 # But ignore docs/build inside docs and code
 docs/build/
 docs/source/gallery/
+docs/source/sg_execution_times.rst
 
 # Compiled files in the project
 *__pycache__*

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/.zenodo.json

@@ -9,8 +9,8 @@
   "license": "MIT",
   "upload_type": "software",
   "access_right": "open",
-  "version": "0.17.3",
-  "publication_date": "2026-10-16",
+  "version": "0.17.4",
+  "publication_date": "2026-10-20",
   "keywords": [
     "optical fibers",
     "guided modes",

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/CHANGELOG.md

@@ -6,6 +6,8 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.17.4] - 2026-10-20
+
 ## [0.17.3] - 2026-10-16
 
 ## [0.17.2] - 2026-10-13
@@ -167,7 +169,8 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Established the current tagged baseline for subsequent documented releases.
 
-[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.17.3...HEAD
+[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.17.4...HEAD
+[0.17.4]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.17.4
 [0.17.3]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.17.3
 [0.17.2]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.17.2
 [0.17.1]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.17.1

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 Use Python 3.11 or newer. Install development dependencies with `python -m pip install -e ".[testing,documentation]"`, then run `python -m pytest`.
 
+Build the documentation with `make docs`. The configuration and layout come from the published `MartinPdeS-docs` package. Run `make docs-install` first if documentation dependencies are missing; use `make docs PYTHON=/path/to/python` to select an environment. Gallery examples execute during the build.
+
 Releases use semantic version tags. Run `make patch`, `make minor`, or `make major` from a clean `master` checkout; the command creates the release commit, tags it, and pushes both. Publishing workflows run only for `v*` tags.
 
 The Conda recipe is at `conda.recipe/meta.yaml`. Do not commit generated documentation, virtual environments, build artefacts, or caches.

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/Makefile

@@ -1,14 +1,18 @@
 .DEFAULT_GOAL := help
 
 PYTHON ?= python3
+SPHINXOPTS ?=
+DOCS_BUILD_DIR ?= docs/build
 TAG_VERSION ?= $(or $(VERSION),$(filter v%,$(MAKECMDGOALS)))
 RELEASE_KIND := $(filter major minor patch,$(MAKECMDGOALS))
 
-.PHONY: help test quality check release-check tag release major minor patch
+.PHONY: help docs docs-install test quality check release-check tag release major minor patch
 
 help:
 	@echo "PyFiberModes development commands"
 	@echo ""
+	@echo "  make docs                  Build documentation and execute gallery examples"
+	@echo "  make docs-install          Install the documentation dependencies"
 	@echo "  make test                  Run the test suite"
 	@echo "  make quality               Run static quality checks"
 	@echo "  make check                 Run tests, quality, and release checks"
@@ -26,6 +30,12 @@ $(TAG_VERSION):
 endif
 endif
 
+docs-install:
+	$(PYTHON) -m pip install -e ".[documentation]"
+
+docs:
+	MPLBACKEND=Agg $(PYTHON) -m sphinx -M html docs/source "$(DOCS_BUILD_DIR)" $(SPHINXOPTS)
+
 test:
 	MPLBACKEND=Agg $(PYTHON) -m pytest
 

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.17.3
+Version: 0.17.4
 Summary: Guided-mode analysis and design for circular optical fibers.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -715,19 +715,14 @@ Requires-Dist: matplotlib>=3.8; extra == "plotting"
 Provides-Extra: benchmarking
 Requires-Dist: pytest-benchmark<6,>=5; extra == "benchmarking"
 Provides-Extra: documentation
+Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
 Requires-Dist: matplotlib>=3.8; extra == "documentation"
-Requires-Dist: numpydoc==1.11.0; extra == "documentation"
-Requires-Dist: sphinx>=5.1.1; extra == "documentation"
-Requires-Dist: sphinx-gallery==0.22.1; extra == "documentation"
-Requires-Dist: sphinx-design<1,>=0.6; extra == "documentation"
-Requires-Dist: sphinx-rtd-theme==3.1.0; extra == "documentation"
-Requires-Dist: pydata-sphinx-theme==0.22.0; extra == "documentation"
 Provides-Extra: dev
 Requires-Dist: ruff<1,>=0.8; extra == "dev"
 Requires-Dist: mypy<3,>=1.15; extra == "dev"
 Dynamic: license-file
 
-.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.png
+.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.svg
    :width: 620
    :align: center
    :alt: PyFiberModes logo

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/PyFiberModes/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.17.3'
-__version_tuple__ = version_tuple = (0, 17, 3)
+__version__ = version = '0.17.4'
+__version_tuple__ = version_tuple = (0, 17, 4)
 
 __commit_id__ = commit_id = None

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/PyFiberModes.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.17.3
+Version: 0.17.4
 Summary: Guided-mode analysis and design for circular optical fibers.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -715,19 +715,14 @@ Requires-Dist: matplotlib>=3.8; extra == "plotting"
 Provides-Extra: benchmarking
 Requires-Dist: pytest-benchmark<6,>=5; extra == "benchmarking"
 Provides-Extra: documentation
+Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
 Requires-Dist: matplotlib>=3.8; extra == "documentation"
-Requires-Dist: numpydoc==1.11.0; extra == "documentation"
-Requires-Dist: sphinx>=5.1.1; extra == "documentation"
-Requires-Dist: sphinx-gallery==0.22.1; extra == "documentation"
-Requires-Dist: sphinx-design<1,>=0.6; extra == "documentation"
-Requires-Dist: sphinx-rtd-theme==3.1.0; extra == "documentation"
-Requires-Dist: pydata-sphinx-theme==0.22.0; extra == "documentation"
 Provides-Extra: dev
 Requires-Dist: ruff<1,>=0.8; extra == "dev"
 Requires-Dist: mypy<3,>=1.15; extra == "dev"
 Dynamic: license-file
 
-.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.png
+.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.svg
    :width: 620
    :align: center
    :alt: PyFiberModes logo

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/PyFiberModes.egg-info/SOURCES.txt

@@ -78,6 +78,7 @@ benchmarks/test_field_performance.py
 conda.recipe/meta.yaml
 docs/Makefile
 docs/make.bat
+docs/redirect.html
 docs/examples/README.rst
 docs/examples/SMF28/README.rst
 docs/examples/SMF28/plot_smf28.py
@@ -132,8 +133,9 @@ docs/source/troubleshooting.rst
 docs/source/workflows.rst
 docs/source/_static/default.css
 docs/source/_static/favicon.png
-docs/source/_static/layout.css
+docs/source/_static/favicon.svg
 docs/source/_static/logo.png
+docs/source/_static/logo.svg
 docs/source/_static/thumbnail.png
 docs/source/code/analysis.rst
 docs/source/code/fibers.rst

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/PyFiberModes.egg-info/requires.txt

@@ -11,13 +11,8 @@ ruff<1,>=0.8
 mypy<3,>=1.15
 
 [documentation]
+MartinPdeS-docs<0.2,>=0.1.4
 matplotlib>=3.8
-numpydoc==1.11.0
-sphinx>=5.1.1
-sphinx-gallery==0.22.1
-sphinx-design<1,>=0.6
-sphinx-rtd-theme==3.1.0
-pydata-sphinx-theme==0.22.0
 
 [plotting]
 matplotlib>=3.8

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/README.rst

@@ -1,4 +1,4 @@
-.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.png
+.. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.svg
    :width: 620
    :align: center
    :alt: PyFiberModes logo

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/conda.recipe/meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: pyfibermodes
-  version: 0.17.3
+  version: 0.17.4
 
 source:
   path: ../

pyfibermodes-0.17.4/docs/redirect.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="refresh" content="0; url=docs/latest/index.html">
+  <link rel="canonical" href="docs/latest/index.html">
+  <title>PyFiberModes documentation</title>
+</head>
+<body>
+  <p>Opening the <a href="docs/latest/index.html">PyFiberModes documentation</a>.</p>
+</body>
+</html>

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/docs/source/_static/default.css

@@ -29,18 +29,6 @@ div.highlight a {
   box-shadow: 0 0.8rem 1.8rem rgb(14 34 90 / 16%);
 }
 
-.navbar-brand img,
-.bd-header .navbar-brand img {
-  max-height: 3rem;
-}
-
 .bd-content img[alt="PyFiberModes logo"] {
   filter: drop-shadow(0 0.7rem 1rem rgb(20 217 255 / 20%));
 }
-
-/* Keep desktop navigation labels compact and on a single line. */
-@media (min-width: 960px) {
-  .bd-header .navbar-nav .nav-link {
-    white-space: nowrap;
-  }
-}

pyfibermodes-0.17.4/docs/source/_static/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><defs><linearGradient id="r" x1="0" y1="0" x2="1" y2="1"><stop stop-color="#8cecff"/><stop offset=".5" stop-color="#16a8d0"/><stop offset="1" stop-color="#172c68"/></linearGradient><radialGradient id="c" cx="35%" cy="32%"><stop stop-color="#d9fbff"/><stop offset="1" stop-color="#08759d"/></radialGradient><radialGradient id="v" cx="35%" cy="32%"><stop stop-color="#f1edff"/><stop offset="1" stop-color="#3c277e"/></radialGradient></defs><rect width="128" height="128" rx="28" fill="#071632"/><circle cx="64" cy="64" r="48" fill="#071632" stroke="url(#r)" stroke-width="10"/><ellipse cx="52" cy="64" rx="23" ry="34" fill="url(#c)"/><ellipse cx="76" cy="64" rx="23" ry="34" fill="url(#v)" opacity=".92"/><circle cx="64" cy="64" r="7" fill="#fff" opacity=".85"/></svg>

pyfibermodes-0.17.4/docs/source/_static/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 560 130" role="img" aria-labelledby="t"><title id="t">PyFiberModes</title><defs><linearGradient id="r" x1="0" y1="0" x2="1" y2="1"><stop stop-color="#8cecff"/><stop offset=".5" stop-color="#16a8d0"/><stop offset="1" stop-color="#172c68"/></linearGradient><radialGradient id="c" cx="35%" cy="32%"><stop stop-color="#d9fbff"/><stop offset=".2" stop-color="#31d5ed"/><stop offset="1" stop-color="#08759d"/></radialGradient><radialGradient id="v" cx="35%" cy="32%"><stop stop-color="#f1edff"/><stop offset=".2" stop-color="#a88cff"/><stop offset="1" stop-color="#3c277e"/></radialGradient><filter id="s"><feDropShadow dx="0" dy="7" stdDeviation="5" flood-color="#07152e" flood-opacity=".7"/></filter></defs><g filter="url(#s)"><circle cx="98" cy="65" r="55" fill="#071632" stroke="url(#r)" stroke-width="11"/><ellipse cx="82" cy="65" rx="27" ry="39" fill="url(#c)"/><ellipse cx="113" cy="65" rx="27" ry="39" fill="url(#v)" opacity=".92"/><circle cx="98" cy="65" r="8" fill="#fff" opacity=".8"/><path d="M40 65H20M156 65h20" stroke="#efa31e" stroke-width="10" stroke-linecap="round"/></g><text x="205" y="82" fill="#10244b" font-family="Arial,sans-serif" font-size="42" font-weight="700">PyFiberModes</text></svg>

pyfibermodes-0.17.4/docs/source/conf.py

@@ -0,0 +1,55 @@
+"""PyFiberModes documentation, using the shared MartinPdeS-docs theme."""
+
+import os
+from pathlib import Path
+import sys
+import tomllib
+
+from martinpdes_docs import configure
+
+
+ROOT = Path(__file__).resolve().parents[2]
+# Gallery examples and autodoc must describe this checkout.
+sys.path.insert(0, str(ROOT))
+
+examples_sections = [
+    "basic",
+    "SMF28",
+    "specialty_fibers",
+    "fields",
+    "analysis",
+    "validation",
+    "benchmarks",
+]
+
+globals().update(
+    configure(
+        project="PyFiberModes",
+        package="PyFiberModes",
+        repository="MartinPdeS/PyFiberModes",
+        logo="_static/logo.svg",
+        favicon="_static/favicon.svg",
+        version=os.getenv("tag", "latest"),
+        html_theme_options={
+            "logo": {"text": "", "image": "_static/logo.svg"},
+        },
+        sphinx_gallery_conf={
+            "examples_dirs": [f"../examples/{name}" for name in examples_sections],
+            "gallery_dirs": [f"gallery/{name}" for name in examples_sections],
+            "default_thumb_file": str(
+                Path(__file__).resolve().parent / "_static" / "favicon.png"
+            ),
+            "within_subsection_order": "FileNameSortKey",
+            "abort_on_example_error": True,
+        },
+    )
+)
+
+extensions += ["sphinx.ext.mathjax", "sphinx.ext.autosectionlabel"]
+autodoc_default_options["members"] = True
+html_context["doc_path"] = "docs/source"
+html_context["default_mode"] = "dark"
+
+# Keep page substitutions independent of importing the numerical package.
+metadata = tomllib.loads((ROOT / "pyproject.toml").read_text(encoding="utf-8"))
+version = release = metadata["project"]["version"]

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/docs/source/index.rst

@@ -1,6 +1,6 @@
 **Date**: |today|, **Version**: |version|
 
-.. image:: _static/logo.png
+.. image:: _static/logo.svg
    :width: 620
    :align: center
    :alt: PyFiberModes logo

{pyfibermodes-0.17.3 → pyfibermodes-0.17.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyFiberModes"
-version = "0.17.3"
+version = "0.17.4"
 description = "Guided-mode analysis and design for circular optical fibers."
 license = {file = "LICENSE"}
 readme = "README.rst"
@@ -79,13 +79,8 @@ benchmarking = [
 
 
 documentation = [
+    "MartinPdeS-docs>=0.1.4,<0.2",
     "matplotlib>=3.8",
-    "numpydoc ==1.11.0",
-    "sphinx >=5.1.1",
-    "sphinx-gallery ==0.22.1",
-    "sphinx-design >=0.6,<1",
-    "sphinx-rtd-theme ==3.1.0",
-    "pydata-sphinx-theme ==0.22.0",
 ]
 
 dev = [

pyfibermodes-0.17.3/.github/workflows/deploy_documentation.yml

@@ -1,19 +0,0 @@
-name: Publish documentation
-
-on:
-  push:
-    branches: [master]
-    tags: ["v*"]
-
-permissions:
-  contents: write
-  pages: write
-  id-token: write
-
-jobs:
-  documentation:
-    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@v5
-    with:
-      python-version: "3.11"
-      package-name: PyFiberModes
-      apt-package: xvfb jq

pyfibermodes-0.17.3/docs/source/_static/layout.css

@@ -1,89 +0,0 @@
-html {
-    --documentation-sidebar-width: 16rem;
-    --pst-sidebar-secondary: 15rem;
-}
-
-.bd-page-width {
-    max-width: none;
-}
-
-.bd-container .bd-container__inner {
-    width: 100%;
-}
-
-.bd-main .bd-content .bd-article-container {
-    flex: 1 1 0;
-    min-width: 0;
-    max-width: none;
-    padding: clamp(1rem, 2.5vw, 3rem);
-}
-
-.bd-main .bd-content .bd-article-container .bd-article {
-    max-width: 78rem;
-    margin-inline: auto;
-    padding: 0;
-    font-size: 1.025rem;
-    line-height: 1.65;
-    overflow-wrap: break-word;
-}
-
-@media (min-width: 960px) {
-    .bd-sidebar-primary,
-    .bd-sidebar-primary.pst-squeeze {
-        --pst-sidebar-primary-width: var(--documentation-sidebar-width);
-        flex: 0 0 var(--documentation-sidebar-width);
-        width: var(--documentation-sidebar-width);
-    }
-
-    #pst-primary-sidebar .pst-sidebar-collapse {
-        display: none;
-    }
-}
-
-@media (min-width: 768px) {
-    #pst-header .navbar-nav {
-        gap: 0.3rem;
-    }
-
-    #pst-header .navbar-nav .nav-item {
-        position: relative;
-    }
-
-    #pst-header .navbar-nav > .nav-item:not(:last-child)::after {
-        position: absolute;
-        top: 50%;
-        right: -0.15rem;
-        height: 1rem;
-        border-right: 1px solid var(--pst-color-border);
-        content: "";
-        transform: translateY(-50%);
-        pointer-events: none;
-    }
-
-    #pst-header .navbar-nav .nav-link {
-        padding: 0.65rem 0.8rem;
-        border-radius: 0.4rem;
-        font-size: 1.05rem;
-        font-weight: 600;
-    }
-}
-
-@media (min-width: 1200px) {
-    #pst-header .navbar-brand {
-        box-sizing: border-box;
-        flex: 0 0 var(--documentation-sidebar-width);
-        width: var(--documentation-sidebar-width);
-    }
-
-    #pst-header .navbar-brand img.logo__image {
-        width: 4rem;
-        height: 4rem;
-        object-fit: contain;
-    }
-
-    #pst-header .navbar-brand .logo__title {
-        font-size: 2rem;
-        line-height: 1;
-        letter-spacing: -0.035em;
-    }
-}