PyFiberModes 0.17.0__tar.gz → 0.17.2__tar.gz

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/.zenodo.json

@@ -9,7 +9,7 @@
   "license": "MIT",
   "upload_type": "software",
   "access_right": "open",
-  "version": "0.17.0",
+  "version": "0.17.2",
   "publication_date": "2026-10-13",
   "keywords": [
     "optical fibers",

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/CHANGELOG.md

@@ -6,6 +6,20 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.17.2] - 2026-10-13
+
+### Fixed
+
+- Updated the documentation navigation regression test for the new Resources
+  grouping.
+
+## [0.17.1] - 2026-10-13
+
+### Changed
+
+- Reorganized the documentation navigation into Start, Guide, Examples, API,
+  and Resources sections.
+
 ## [0.17.0] - 2026-10-13
 
 ## [0.16.0] - 2026-09-23
@@ -151,7 +165,9 @@ 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.0...HEAD
+[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.17.2...HEAD
+[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
 [0.17.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.17.0
 [0.16.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.16.0
 [0.15.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.15.0

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.17.0
+Version: 0.17.2
 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

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/PyFiberModes/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.17.0'
-__version_tuple__ = version_tuple = (0, 17, 0)
+__version__ = version = '0.17.2'
+__version_tuple__ = version_tuple = (0, 17, 2)
 
 __commit_id__ = commit_id = None

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/PyFiberModes.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.17.0
+Version: 0.17.2
 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

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/PyFiberModes.egg-info/SOURCES.txt

@@ -120,11 +120,13 @@ docs/source/code.rst
 docs/source/conf.py
 docs/source/examples.rst
 docs/source/getting_started.rst
+docs/source/guide.rst
 docs/source/index.rst
 docs/source/migration_guide.rst
 docs/source/performance.rst
 docs/source/public_api_contract.rst
 docs/source/references.rst
+docs/source/resources.rst
 docs/source/theory.rst
 docs/source/troubleshooting.rst
 docs/source/workflows.rst

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/conda.recipe/meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: pyfibermodes
-  version: 0.17.0
+  version: 0.17.2
 
 source:
   path: ../

pyfibermodes-0.17.2/docs/source/guide.rst

@@ -0,0 +1,37 @@
+Guide
+=====
+
+Learn the fundamentals of fiber modeling, then follow a workflow suited to
+your calculation.
+
+.. grid:: 1 1 3 3
+   :gutter: 2
+
+   .. grid-item-card:: User guide
+      :link: user_guide/index
+      :link-type: doc
+
+      Work through fiber definitions, modes, fields, units, and parameter
+      sweeps.
+
+   .. grid-item-card:: Workflows
+      :link: workflows
+      :link-type: doc
+
+      Choose a practical path for characterization, field analysis, design,
+      or coupled-mode propagation.
+
+   .. grid-item-card:: Theory
+      :link: theory
+      :link-type: doc
+
+      Review the mode families, normalized frequency, and numerical
+      conventions behind the calculations.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   user_guide/index
+   workflows
+   theory

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/docs/source/index.rst

@@ -12,19 +12,11 @@
     :maxdepth: 2
     :hidden:
 
-    Getting started <getting_started.rst>
-    User guide <user_guide/index.rst>
-    Theory <theory.rst>
-    Architecture <architecture.rst>
-    API policy <api_policy.rst>
-    Public API contract <public_api_contract.rst>
-    Migration <migration_guide.rst>
-    Workflows <workflows.rst>
-    Performance <performance.rst>
-    Troubleshooting <troubleshooting.rst>
+    Start <getting_started.rst>
+    Guide <guide.rst>
     Examples <examples.rst>
-    API reference <code.rst>
-    References <references.rst>
+    API <code.rst>
+    Resources <resources.rst>
 
 Choose your path
 ----------------

pyfibermodes-0.17.2/docs/source/resources.rst

@@ -0,0 +1,62 @@
+Resources
+=========
+
+Find guidance on numerical reliability, compatibility, and the design of the
+PyFiberModes public API.
+
+.. grid:: 1 2 3 3
+   :gutter: 2
+
+   .. grid-item-card:: Architecture
+      :link: architecture
+      :link-type: doc
+
+      Understand the package structure and the roles of its main components.
+
+   .. grid-item-card:: API policy
+      :link: api_policy
+      :link-type: doc
+
+      Learn which imports are public and how compatibility is managed.
+
+   .. grid-item-card:: Public API contract
+      :link: public_api_contract
+      :link-type: doc
+
+      Review the supported names and guarantees of the public interface.
+
+   .. grid-item-card:: Migration guide
+      :link: migration_guide
+      :link-type: doc
+
+      Find user-facing changes and guidance for updating existing code.
+
+   .. grid-item-card:: Performance
+      :link: performance
+      :link-type: doc
+
+      Plan parameter grids, control memory use, and benchmark fairly.
+
+   .. grid-item-card:: Troubleshooting
+      :link: troubleshooting
+      :link-type: doc
+
+      Resolve installation and runtime issues.
+
+   .. grid-item-card:: References
+      :link: references
+      :link-type: doc
+
+      Consult the sources behind the implemented methods.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   architecture
+   api_policy
+   public_api_contract
+   migration_guide
+   performance
+   troubleshooting
+   references

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyFiberModes"
-version = "0.17.0"
+version = "0.17.2"
 description = "Guided-mode analysis and design for circular optical fibers."
 license = {file = "LICENSE"}
 readme = "README.rst"

{pyfibermodes-0.17.0 → pyfibermodes-0.17.2}/tests/test_public_api.py

@@ -71,11 +71,13 @@ def test_compatibility_documents_are_published_in_navigation():
     """Keep the policy and migration guide visible in built documentation."""
     documentation = PROJECT_ROOT / "docs" / "source"
     navigation = (documentation / "index.rst").read_text(encoding="utf-8")
+    resources = (documentation / "resources.rst").read_text(encoding="utf-8")
     policy = (documentation / "api_policy.rst").read_text(encoding="utf-8")
     migration = (documentation / "migration_guide.rst").read_text(encoding="utf-8")
 
-    assert "api_policy.rst" in navigation
-    assert "public_api_contract.rst" in navigation
-    assert "migration_guide.rst" in navigation
+    assert "Resources <resources.rst>" in navigation
+    assert ":link: api_policy" in resources
+    assert ":link: public_api_contract" in resources
+    assert ":link: migration_guide" in resources
     assert "at least two minor releases and six months" in policy
     assert "Unreleased" in migration