PyOptik 1.9.5.post0__tar.gz → 1.9.7__tar.gz

pyoptik-1.9.7/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,121 @@
+# .github/workflows/deploy_documentation.yml
+name: Documentation
+
+on:
+  push:
+    branches: [ "master" ]
+    tags:
+      - '*'
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  documentation:
+    name: Run the documentation building tools
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+
+    steps:
+      - name: "Set-up: Python 3.11"
+        uses: actions/setup-python@v5
+        id: cp311
+        with:
+            python-version: "3.11"
+
+      - name: "Install: Dependencies for headless server"
+        shell: bash
+        run: |
+            sudo apt-get update
+            sudo apt-get install xvfb
+
+      - name: "Checkout requirements and files for testing"
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Install everything, run the tests, produce the .coverage file
+        run: |
+          python -m pip install wheel build
+          python -m build --wheel
+          python -m pip install .[documentation]
+
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser jq
+
+      - name: Get current tag
+        id: get_tag
+        run: |
+          git fetch --tags
+          echo "tag=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
+
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source _build
+
+      - name: "Deploy to documentation_page: specific version"
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        with:
+          publish_branch: documentation_page
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          destination_dir: "docs/${{ env.tag }}"
+          keep_files: true
+
+  update_version_switcher:
+    name: Update version_switcher.json
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    needs: documentation  # This job depends on the successful completion of the 'documentation' job
+    permissions:
+      contents: write
+
+    steps:
+      - name: "Checkout documentation_page branch"
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: documentation_page  # Directly check out the documentation_page branch
+
+      - name: Install jq for JSON manipulation
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y jq
+
+      - name: Get current tag from GITHUB_REF
+        run: |
+          # Extract the tag name from GITHUB_REF, which should be refs/tags/<tag>
+          tag="${GITHUB_REF#refs/tags/}"
+          echo "tag=$tag" >> $GITHUB_ENV
+          echo "Current tag: $tag"
+
+      - name: Update version_switcher.json with new tag
+        env:
+          TAG: ${{ env.tag }}
+        run: |
+          # Define the path to version_switcher.json and new version details
+          json_file="version_switcher.json"
+          current_tag="${TAG}"
+          json_url="https://martinpdes.github.io/PyOptik/docs/${current_tag}"
+
+          # Create a new JSON entry for the current tag
+          new_entry=$(jq -n \
+            --arg name "$current_tag" \
+            --arg version "$current_tag" \
+            --arg url "$json_url" \
+            '{name: $name, version: $version, url: $url}')
+
+          # Append new entry to version_switcher.json
+          jq ". + [$new_entry]" $json_file > temp.json && mv temp.json $json_file
+
+      - name: Commit and push the updated version_switcher.json
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add version_switcher.json
+          git commit -m "Update version_switcher.json with new tag ${{ env.tag }}"
+          git push origin documentation_page

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.5.post0
+Version: 1.9.7
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.9.5.post0'
-__version_tuple__ = version_tuple = (1, 9, 5)
+__version__ = version = '1.9.7'
+__version_tuple__ = version_tuple = (1, 9, 7)

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.5.post0
+Version: 1.9.7
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/PyOptik.egg-info/SOURCES.txt

@@ -6,10 +6,10 @@ README.rst
 meta.yaml
 pyproject.toml
 .github/dependabot.yml
+.github/workflows/deploy_PyPi.yml
 .github/workflows/deploy_anaconda.yml
 .github/workflows/deploy_coverage.yml
 .github/workflows/deploy_documentation.yml
-.github/workflows/deploy_workflow.yml
 PyOptik/__init__.py
 PyOptik/__main__.py
 PyOptik/_version.py
@@ -83,6 +83,7 @@ docs/source/conf.py
 docs/source/index.rst
 docs/source/references.rst
 docs/source/_static/default.css
+docs/source/_static/thumbnail.png
 docs/source/gallery/index.rst
 tests/__init__.py
 tests/test_sellmeier.py

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/docs/source/conf.py

@@ -2,15 +2,14 @@
 # -*- coding: utf-8 -*-
 
 import sys
-from sphinx_gallery.sorting import FileNameSortKey
+import os
 from MPSPlots.styles import use_mpsplots_style
-
+from pathlib import Path
 import PyOptik
-from PyOptik.directories import project_path, doc_css_path
+from PyOptik.directories import doc_css_path
 
 
-sys.path.insert(0, project_path)
-sys.path.insert(0, project_path.joinpath('PyOptik'))
+sys.path.append(str(Path(".").resolve()))
 
 
 def setup(app):
@@ -47,6 +46,9 @@ extensions = [
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 
+html_logo = "_static/thumbnail.png"
+html_favicon = "_static/thumbnail.png"
+
 
 def reset_mpl(gallery_conf, fname):
     use_mpsplots_style()
@@ -68,7 +70,6 @@ sphinx_gallery_conf = {
     'reset_modules': reset_mpl,
     'line_numbers': False,
     'remove_config_comments': True,
-    'within_subsection_order': FileNameSortKey,
     'capture_repr': ('_repr_html_', '__repr__'),
     'nested_sections': True,
 }
@@ -102,13 +103,12 @@ pygments_style = "sphinx"
 major, minor = version[:2]
 binder_branch = f"v{major}.{minor}.x"
 
-html_theme_options = {
-    # Navigation bar
-    "logo": {
-        "alt_text": "PyOptik's logo",
-        "text": "PyOptik",
-        "link": "https://martinpdes.github.io/PyOptik/",
-    },
+html_theme_options = dict()
+
+html_theme_options['logo'] = dict(text='PyOptik', image="_static/thumbnail.png")
+html_theme_options["show_nav_level"] = 0
+
+html_theme_options.update({
     "icon_links": [
         {
             "name": "GitHub",
@@ -134,9 +134,17 @@ html_theme_options = {
     "footer_start": ["copyright"],
     "footer_end": ["sphinx-version", "theme-version"],
     # Other
-    "pygment_light_style": "default",
-    "pygment_dark_style": "github-dark",
+    "pygments_light_style": "default",
+    "pygments_dark_style": "github-dark",
 }
+)
+
+current_version = os.getenv("tag", "latest")
+
+html_theme_options["switcher"] = dict(
+    json_url="https://raw.githubusercontent.com/MartinPdeS/PyOptik/documentation_page/version_switcher.json",
+    version_match=current_version,
+)
 
 htmlhelp_basename = 'PyOptikdoc'
 

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/meta.yaml

@@ -17,12 +17,11 @@ channels:
 
 requirements:
   host:
-    - python >=3.8
+    - python {{ PY_VER }}*
     - setuptools >=40.8.0
     - wheel
     - setuptools-scm >=8.0
     - pip
-    - martinpdes::mpsplots
   run:
     - flexparser <0.4  # This is due to a dataclass inheritance problem coming from the pint package
     - pint ~= 0.24
@@ -51,6 +50,7 @@ test:
   imports:
     - PyOptik
   requires:
+    - python {{ PY_VER }}*
     - pytest>=0.6
     - pytest-cov>=2.0
     - pytest-json-report==1.5.0

{pyoptik-1.9.5.post0 → pyoptik-1.9.7}/pyproject.toml

@@ -41,7 +41,7 @@ include-package-data = true
 
 [tool.setuptools_scm]
 write_to = "PyOptik/_version.py"
-version_scheme = "post-release"
+version_scheme = "only-version"
 local_scheme = "no-local-version"
 
 [project.optional-dependencies]

pyoptik-1.9.5.post0/.github/workflows/deploy_documentation.yml

@@ -1,60 +0,0 @@
-# .github/workflows/deploy_documentation.yml
-name: Documentation
-
-on:
-  push:
-    branches: [ "master" ]
-    tags:
-      - '*'
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  documentation:
-    name: Run the documentation building tools
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-      contents: write
-
-    steps:
-      - name: "Set-up: Python 3.10"
-        uses: actions/setup-python@v4
-        id: cp310
-        with:
-            python-version: "3.10"
-
-      - name: "Install: Dependencies for headless server"
-        shell: bash
-        run: |
-            sudo apt-get update
-            sudo apt-get install xvfb
-
-      - name: "Checkout requirements and files for testing"
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          submodules: true
-
-      - name: Install everything, run the tests, produce the .coverage file
-        run: |
-          python -m pip install wheel build
-          python -m build --wheel
-          python -m pip install .[documentation]
-
-      - name: Install dependencies
-        run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
-
-      - name: Sphinx build
-        run: |
-          sphinx-build docs/source _build
-
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-        with:
-          publish_branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: _build/
-          force_orphan: true