mesh2scattering 1.0.1__tar.gz → 1.0.2__tar.gz

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/CHANGELOG.md

@@ -3,6 +3,12 @@
 
 ## mesh2scattering
 
+### v1.0.2 - (2025-06-06)
+
+- doc: add examples to documentation ([#59](https://github.com/ahms5/Mesh2scattering/pulls/59))
+- doc: Fix link to Github in documentation ([#61](https://github.com/ahms5/Mesh2scattering/pulls/61))
+- ci: fix auto release on github ([#58](https://github.com/ahms5/Mesh2scattering/pulls/58))
+
 ### v1.0.1 - (2025-04-25)
 
 - fix copyright in documentation

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mesh2scattering
-Version: 1.0.1
+Version: 1.0.2
 Summary: Numerical calculation of surface scattering.
 License:                       EUROPEAN UNION PUBLIC LICENCE v. 1.2
                               EUPL © the European Union 2007, 2016
@@ -338,6 +338,10 @@ Requires-Dist: sphinx_mdinclude; extra == "docs"
 Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinx-favicon; extra == "docs"
 Requires-Dist: sphinx-reredirects; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: sphinx_gallery; extra == "docs"
+Requires-Dist: nbsphinx_link; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: mesh2scattering[deploy,docs,tests]; extra == "dev"
 Dynamic: license-file

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/docs/conf.py

@@ -29,7 +29,10 @@ extensions = [
     'sphinx_design',
     'sphinx_favicon',
     'sphinx_mdinclude',
+    'nbsphinx',
+    'nbsphinx_link',
 ]
+suppress_warnings = ["config.cache"]
 
 # show tocs for classes and functions of modules using the autodocsumm
 # package
@@ -73,7 +76,12 @@ language = 'en'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+    '**.ipynb_checkpoints',
+    ]
 
 # The name of the Pygments (syntax highlighting) style to use (Not defining
 # uses the default style of the html_theme).
@@ -120,7 +128,7 @@ html_theme_options = {
     "icon_links": [
         {
           "name": "GitHub",
-          "url": "https://github.com/pyfar",
+          "url": "https://github.com/ahms5/mesh2scattering",
           "icon": "fa-brands fa-square-github",
           "type": "fontawesome",
         },

mesh2scattering-1.0.2/docs/examples.rst

@@ -0,0 +1,7 @@
+Examples
+========
+
+.. toctree::
+    :maxdepth: 1
+
+    examples/demo

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/docs/index.rst

@@ -6,6 +6,7 @@ mesh2scattering
    :hidden:
 
    readme
+   examples
    api_reference
    contributing
    history
@@ -28,6 +29,17 @@ Python Boilerplate contains all the boilerplate you need to create a Python pack
 
             <i class="fa-solid fa-rocket icon-style"></i>
 
+    .. grid-item-card::
+        :link: examples.html
+        :text-align: center
+        :padding: 0 0 3 3
+
+        **Examples**
+        ^^^^
+
+        .. raw:: html
+
+            <i class="fa-solid fa-book icon-style"></i>
 
     .. grid-item-card::
         :link: api_reference

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/mesh2scattering/__init__.py

@@ -4,7 +4,7 @@
 
 __author__ = """The Mesh2hrtf and mesh2scattering developers"""
 __email__ = ''
-__version__ = '1.0.1'
+__version__ = '1.0.2'
 
 from . import input  # noqa: A004
 from . import numcalc

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/mesh2scattering.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mesh2scattering
-Version: 1.0.1
+Version: 1.0.2
 Summary: Numerical calculation of surface scattering.
 License:                       EUROPEAN UNION PUBLIC LICENCE v. 1.2
                               EUPL © the European Union 2007, 2016
@@ -338,6 +338,10 @@ Requires-Dist: sphinx_mdinclude; extra == "docs"
 Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinx-favicon; extra == "docs"
 Requires-Dist: sphinx-reredirects; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: sphinx_gallery; extra == "docs"
+Requires-Dist: nbsphinx_link; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: mesh2scattering[deploy,docs,tests]; extra == "dev"
 Dynamic: license-file

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/mesh2scattering.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ docs/Makefile
 docs/api_reference.rst
 docs/conf.py
 docs/contributing.rst
+docs/examples.rst
 docs/history.rst
 docs/index.rst
 docs/make.bat

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/mesh2scattering.egg-info/requires.txt

@@ -25,6 +25,10 @@ sphinx_mdinclude
 sphinx-design
 sphinx-favicon
 sphinx-reredirects
+nbsphinx
+sphinx_gallery
+nbsphinx_link
+ipython
 
 [tests]
 pytest

{mesh2scattering-1.0.1 → mesh2scattering-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mesh2scattering"
-version = "1.0.1"
+version = "1.0.2"
 description = "Numerical calculation of surface scattering."
 readme = "README.md"
 license = {file = "LICENSE.txt"}
@@ -56,6 +56,10 @@ docs = [
     "sphinx-design",
     "sphinx-favicon",
     "sphinx-reredirects",
+    "nbsphinx",
+    "sphinx_gallery",
+    "nbsphinx_link",
+    "ipython",
 ]
 dev = ["mesh2scattering[deploy,tests,docs]"]
 
@@ -131,7 +135,7 @@ convention = "numpy"
 
 
 [tool.bumpversion]
-current_version = "1.0.1"
+current_version = "1.0.2"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"