PyOptik 1.9.8.4__tar.gz → 1.9.8.9__tar.gz

pyoptik-1.9.8.9/.github/workflows/create_documentation.yml

@@ -0,0 +1,102 @@
+# .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 -y xvfb jq
+
+      - 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: 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
+          git checkout documentation_page
+          git branch documentation_page_temp
+          cd docs
+          git checkout master -- _build
+          mv _build ${{ env.tag }}"
+          cd ..
+
+      - name: Scan, sort versions, and update version_switcher.json
+        run: |
+          # Define the path to version_switcher.json
+          json_file="version_switcher.json"
+          docs_path="docs"
+          base_url="https://martinpdes.github.io/PyOptik"
+
+          # Start the JSON array
+          echo "[" > $json_file
+
+          # Get sorted version directories in descending order
+          version_dirs=$(ls -v $docs_path | sort -V -r)
+
+          # Loop over sorted versions and add to JSON file
+          first_entry=true
+          for version in $version_dirs; do
+            version_url="${base_url}/${docs_path}/${version}"
+
+            # Add a comma if it's not the first entry
+            if [ "$first_entry" = true ]; then
+              first_entry=false
+            else
+              echo "," >> $json_file
+            fi
+
+            # Append each version as a JSON entry
+            jq -n \
+              --arg name "$version" \
+              --arg version "$version" \
+              --arg url "$version_url" \
+              '{name: $name, version: $version, url: $url}' >> $json_file
+          done
+
+          # End the JSON array
+          echo "]" >> $json_file
+
+      - name: Merge to Trigger Pages Build
+        run: |
+          # Merge the changes from documentation_page_temp to documentation_page
+          git checkout documentation_page
+          git merge documentation_page_temp --no-ff
+          git push origin documentation_page

{pyoptik-1.9.8.4 → pyoptik-1.9.8.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.8.4
+Version: 1.9.8.9
 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.8.4 → pyoptik-1.9.8.9}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.9.8.4'
-__version_tuple__ = version_tuple = (1, 9, 8, 4)
+__version__ = version = '1.9.8.9'
+__version_tuple__ = version_tuple = (1, 9, 8, 9)

{pyoptik-1.9.8.4 → pyoptik-1.9.8.9}/PyOptik/material_bank.py

@@ -24,7 +24,7 @@ class _MaterialBank():
 
     The `_MaterialBank` class provides access to a predefined list of materials used in optical simulations,
     categorized into Sellmeier and Tabulated materials. It allows users to dynamically retrieve materials
-    based on their names without the need to instantiate the class. The material bank can be expanded
+    based on their names without the need to instantiate the class.  The material bank can be expanded
     or modified by adding or removing materials from the bank, and it provides utilities to fetch material data
     dynamically when accessed as class attributes.
 

{pyoptik-1.9.8.4 → pyoptik-1.9.8.9}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.8.4
+Version: 1.9.8.9
 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.8.4 → pyoptik-1.9.8.9}/PyOptik.egg-info/SOURCES.txt

@@ -6,11 +6,10 @@ README.rst
 meta.yaml
 pyproject.toml
 .github/dependabot.yml
-.github/workflows/add_documentation_version.yml
+.github/workflows/create_documentation.yml
 .github/workflows/deploy_PyPi.yml
 .github/workflows/deploy_anaconda.yml
 .github/workflows/deploy_coverage.yml
-.github/workflows/deploy_documentation.yml
 PyOptik/__init__.py
 PyOptik/__main__.py
 PyOptik/_version.py

pyoptik-1.9.8.4/.github/workflows/add_documentation_version.yml

@@ -1,73 +0,0 @@
-name: Update Documentation Versions
-
-on:
-  push:
-    branches:
-      - documentation_page  # Run on pushes to documentation_page branch
-    tags:
-      - '*'  # Run on all new tags
-
-jobs:
-  update_version_switcher:
-    name: Update version_switcher.json
-    runs-on: ubuntu-latest
-    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: Scan for versions in docs folder and update version_switcher.json
-        run: |
-          # Define the path to version_switcher.json
-          json_file="version_switcher.json"
-          docs_path="docs"
-          base_url="https://martinpdes.github.io/PyOptik"
-
-          # Initialize an empty array for versions in JSON format
-          versions_list=$(mktemp)  # Temporary file to store the array
-
-          echo "[" > $versions_list  # Start of the JSON array
-
-          # Scan each directory in docs and add it to the versions list
-          first_entry=true
-          for version_dir in ${docs_path}/*/; do
-            version=$(basename "$version_dir")
-            version_url="${base_url}/${docs_path}/${version}"
-
-            # Add a comma if it's not the first entry
-            if [ "$first_entry" = true ]; then
-              first_entry=false
-            else
-              echo "," >> $versions_list
-            fi
-
-            # Append each version as a JSON entry
-            jq -n \
-              --arg name "$version" \
-              --arg version "$version" \
-              --arg url "$version_url" \
-              '{name: $name, version: $version, url: $url}' >> $versions_list
-          done
-
-          echo "]" >> $versions_list  # End of the JSON array
-
-          # Move the temporary array file to version_switcher.json
-          mv $versions_list $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 all versions in docs folder"
-          git push origin documentation_page

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

@@ -1,67 +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.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