PyMieSimX 0.4.3__tar.gz → 0.4.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.github/workflows/deploy_coverage.yml +1 -1
  2. pymiesimx-0.4.4/.github/workflows/deploy_documentation.yml +116 -0
  3. pymiesimx-0.4.3/.github/workflows/deploy_anaconda.yml → pymiesimx-0.4.4/.github/workflows/deploy_release.yml +12 -3
  4. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PKG-INFO +3 -3
  5. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/PKG-INFO +3 -3
  6. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/SOURCES.txt +4 -2
  7. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/requires.txt +2 -2
  8. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/scm_file_list.json +4 -2
  9. pymiesimx-0.4.4/PyMieSimX.egg-info/scm_version.json +8 -0
  10. pymiesimx-0.4.4/docs/redirect.html +13 -0
  11. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/conf.py +0 -10
  12. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/index.rst +2 -13
  13. pymiesimx-0.4.4/docs/source/project.rst +9 -0
  14. pymiesimx-0.4.4/docs/source/reference.rst +10 -0
  15. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/pyproject.toml +2 -2
  16. pymiesimx-0.4.3/.github/workflows/deploy_PyPi.yml +0 -17
  17. pymiesimx-0.4.3/.github/workflows/deploy_documentation.yml +0 -26
  18. pymiesimx-0.4.3/PyMieSimX.egg-info/scm_version.json +0 -8
  19. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.coveragerc +0 -0
  20. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.flake8 +0 -0
  21. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.github/dependabot.yml +0 -0
  22. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.github/workflows/quality.yml +0 -0
  23. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.github/workflows/tests.yml +0 -0
  24. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.gitignore +0 -0
  25. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/.pre-commit-config.yaml +0 -0
  26. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/AGENTS.md +0 -0
  27. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/CONTRIBUTING.md +0 -0
  28. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/Dockerfile +0 -0
  29. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/LICENSE +0 -0
  30. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/__init__.py +0 -0
  31. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/__main__.py +0 -0
  32. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/api.py +0 -0
  33. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/application/__init__.py +0 -0
  34. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/application/wsgi.py +0 -0
  35. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/__init__.py +0 -0
  36. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/admin.py +0 -0
  37. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/card-state.js +0 -0
  38. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/dashboard.css +0 -0
  39. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/default-settings.json +0 -0
  40. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/home-spf-radial.gif +0 -0
  41. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/home-spf-radial.png +0 -0
  42. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/logo.png +0 -0
  43. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/materials-stock.json +0 -0
  44. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/pymiesim-favicon.svg +0 -0
  45. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/pymiesim-logo-dark.svg +0 -0
  46. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/pymiesim-logo.svg +0 -0
  47. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/assets/simulation-sharing.js +0 -0
  48. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/callback_helpers.py +0 -0
  49. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/callbacks.py +0 -0
  50. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/components/__init__.py +0 -0
  51. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/components/cards.py +0 -0
  52. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/computation.py +0 -0
  53. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/defaults.py +0 -0
  54. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/experiment_service.py +0 -0
  55. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/interface.py +0 -0
  56. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/jobs.py +0 -0
  57. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/layout.py +0 -0
  58. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/material_catalog.py +0 -0
  59. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/models.py +0 -0
  60. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/__init__.py +0 -0
  61. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/citation.py +0 -0
  62. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/documentation.py +0 -0
  63. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/examples.py +0 -0
  64. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/experiment/__init__.py +0 -0
  65. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/experiment/page.py +0 -0
  66. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/experiment/sections/__init__.py +0 -0
  67. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/experiment/sections/configuration.py +0 -0
  68. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/field_syntax.py +0 -0
  69. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/home.py +0 -0
  70. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/install_local.py +0 -0
  71. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/population.py +0 -0
  72. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/sellmeier.py +0 -0
  73. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/settings.py +0 -0
  74. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/single/__init__.py +0 -0
  75. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/single/page.py +0 -0
  76. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/single/sections/__init__.py +0 -0
  77. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/single/sections/representations.py +0 -0
  78. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/pages/single/sections/setup.py +0 -0
  79. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/parsing.py +0 -0
  80. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/plotting.py +0 -0
  81. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/population_service.py +0 -0
  82. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/schemas.py +0 -0
  83. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/seo.py +0 -0
  84. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/services.py +0 -0
  85. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/sharing.py +0 -0
  86. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/single_service.py +0 -0
  87. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/usage_metrics.py +0 -0
  88. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX/gui/validation.py +0 -0
  89. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/dependency_links.txt +0 -0
  90. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/entry_points.txt +0 -0
  91. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/PyMieSimX.egg-info/top_level.txt +0 -0
  92. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/README.rst +0 -0
  93. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/conda.recipe/meta.yaml +0 -0
  94. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/_static/favicon.svg +0 -0
  95. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/_static/logo.svg +0 -0
  96. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/api.rst +0 -0
  97. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/contributing.rst +0 -0
  98. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/getting_started.rst +0 -0
  99. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/gui.rst +0 -0
  100. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/how_it_works.rst +0 -0
  101. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/docs/source/sharing.rst +0 -0
  102. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/makefile +0 -0
  103. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/pytest.ini +0 -0
  104. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/setup.cfg +0 -0
  105. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/browser/test_dashboard.py +0 -0
  106. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/cli.py +0 -0
  107. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_admin.py +0 -0
  108. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_api.py +0 -0
  109. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_dash_callbacks.py +0 -0
  110. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_examples.py +0 -0
  111. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_home.py +0 -0
  112. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_population.py +0 -0
  113. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_seo.py +0 -0
  114. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_services.py +0 -0
  115. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_sharing.py +0 -0
  116. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tests/gui/test_usage_metrics.py +0 -0
  117. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tools/generate_home_spf.py +0 -0
  118. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tools/next_release_version.py +0 -0
  119. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tools/release_tag.py +0 -0
  120. {pymiesimx-0.4.3 → pymiesimx-0.4.4}/tools/verify_conda_artifact.py +0 -0
@@ -41,7 +41,7 @@ jobs:
41
41
 
42
42
  - name: Post coverage comment
43
43
  if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
44
- uses: py-cov-action/python-coverage-comment-action@v3
44
+ uses: py-cov-action/python-coverage-comment-action@a05be3d2e8a6272d3ef5fb2840ab20368bb2eb71
45
45
  with:
46
46
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47
47
  MINIMUM_GREEN: 90
@@ -0,0 +1,116 @@
1
+ # Build and publish the versioned documentation site.
2
+ name: Documentation
3
+
4
+ on:
5
+ push:
6
+ branches: ["**"]
7
+ tags: ["v*"]
8
+ pull_request:
9
+ branches: ["master"]
10
+
11
+ concurrency:
12
+ group: documentation-build-${{ github.repository }}
13
+ cancel-in-progress: false
14
+
15
+ permissions:
16
+ contents: write
17
+ pages: write
18
+ id-token: write
19
+
20
+ jobs:
21
+ ManyLinux_x86_64:
22
+ uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@a01969bc5af90666281f9d37acffdf6a4629763a
23
+ with:
24
+ python-version: "3.11"
25
+ package-name: "PyMieSimX"
26
+ apt-package: xvfb jq
27
+ deploy-pages: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
28
+
29
+ prune_documentation_versions:
30
+ needs: ManyLinux_x86_64
31
+ if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
32
+ runs-on: ubuntu-latest
33
+ env:
34
+ DOCUMENTATION_BRANCH: documentation_page
35
+ VERSION_RETENTION_COUNT: 5
36
+
37
+ steps:
38
+ - name: Checkout documentation branch
39
+ uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
40
+ with:
41
+ fetch-depth: 0
42
+ ref: ${{ env.DOCUMENTATION_BRANCH }}
43
+
44
+ - name: Retain only the newest documentation versions
45
+ run: |
46
+ set -Eeuo pipefail
47
+
48
+ mapfile -t versions < <(
49
+ find docs \
50
+ -mindepth 1 \
51
+ -maxdepth 1 \
52
+ -type d \
53
+ -printf "%f\n" \
54
+ | grep -v "^latest$" \
55
+ | sort -V -r
56
+ )
57
+
58
+ for version in "${versions[@]:${VERSION_RETENTION_COUNT}}"; do
59
+ git rm -r -- "docs/${version}"
60
+ done
61
+
62
+ - name: Install documentation landing page
63
+ run: |
64
+ set -Eeuo pipefail
65
+ git show "${GITHUB_SHA}:docs/redirect.html" > index.html
66
+ test -s docs/latest/index.html
67
+
68
+ - name: Rebuild version switcher
69
+ run: |
70
+ set -Eeuo pipefail
71
+
72
+ base_url="https://martinpdes.github.io/PyMieSimX/docs"
73
+ mapfile -t versions < <(
74
+ find docs \
75
+ -mindepth 1 \
76
+ -maxdepth 1 \
77
+ -type d \
78
+ -printf "%f\n" \
79
+ | grep -v "^latest$" \
80
+ | sort -V -r
81
+ )
82
+
83
+ jq -n \
84
+ --arg base_url "${base_url}" \
85
+ --argjson versions "$(printf '%s\n' "${versions[@]}" | jq -R . | jq -s .)" \
86
+ '[
87
+ {
88
+ name: "latest",
89
+ version: "latest",
90
+ url: ($base_url + "/latest")
91
+ }
92
+ ] + [
93
+ $versions[] | {
94
+ name: .,
95
+ version: .,
96
+ url: ($base_url + "/" + .)
97
+ }
98
+ ]' > version_switcher.json
99
+
100
+ jq . version_switcher.json
101
+
102
+ - name: Commit pruned documentation
103
+ run: |
104
+ set -Eeuo pipefail
105
+
106
+ git config user.name "github-actions[bot]"
107
+ git config user.email "github-actions[bot]@users.noreply.github.com"
108
+ git add index.html version_switcher.json
109
+
110
+ if git diff --cached --quiet; then
111
+ echo "Documentation landing page and retention policy are up to date."
112
+ exit 0
113
+ fi
114
+
115
+ git commit -m "Update documentation landing page and retain ${VERSION_RETENTION_COUNT} versions [skip ci]"
116
+ git push origin "HEAD:${DOCUMENTATION_BRANCH}"
@@ -1,7 +1,6 @@
1
- name: Publish Conda package
1
+ name: Publish release
2
2
 
3
3
  on:
4
- workflow_dispatch:
5
4
  push:
6
5
  tags: ["v*"]
7
6
 
@@ -9,7 +8,17 @@ permissions:
9
8
  contents: read
10
9
 
11
10
  jobs:
12
- publish:
11
+ pypi:
12
+ name: Publish to PyPI
13
+ uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@a01969bc5af90666281f9d37acffdf6a4629763a
14
+ with:
15
+ python-version: "3.11"
16
+ test-command: python -c "import PyMieSimX"
17
+ secrets:
18
+ PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
19
+
20
+ conda:
21
+ name: Publish Conda package
13
22
  uses: MartinPdeS/MPSActions/.github/workflows/publish_compiled_package_to_anaconda.yml@a01969bc5af90666281f9d37acffdf6a4629763a
14
23
  with:
15
24
  python_versions: '["3.11", "3.12", "3.13", "3.14"]'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: PyMieSimX
3
- Version: 0.4.3
3
+ Version: 0.4.4
4
4
  Summary: Graphical Dash interface for PyMieSim.
5
5
  Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
6
  License-Expression: MIT
@@ -32,9 +32,9 @@ Requires-Dist: build>=1.2; extra == "dev"
32
32
  Requires-Dist: mypy==1.15.0; extra == "dev"
33
33
  Requires-Dist: ruff==0.11.2; extra == "dev"
34
34
  Provides-Extra: docs
35
- Requires-Dist: MartinPdeS-docs>=0.1.4; extra == "docs"
35
+ Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "docs"
36
36
  Provides-Extra: documentation
37
- Requires-Dist: MartinPdeS-docs>=0.1.4; extra == "documentation"
37
+ Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "documentation"
38
38
  Dynamic: license-file
39
39
 
40
40
  PyMieSimX
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: PyMieSimX
3
- Version: 0.4.3
3
+ Version: 0.4.4
4
4
  Summary: Graphical Dash interface for PyMieSim.
5
5
  Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
6
  License-Expression: MIT
@@ -32,9 +32,9 @@ Requires-Dist: build>=1.2; extra == "dev"
32
32
  Requires-Dist: mypy==1.15.0; extra == "dev"
33
33
  Requires-Dist: ruff==0.11.2; extra == "dev"
34
34
  Provides-Extra: docs
35
- Requires-Dist: MartinPdeS-docs>=0.1.4; extra == "docs"
35
+ Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "docs"
36
36
  Provides-Extra: documentation
37
- Requires-Dist: MartinPdeS-docs>=0.1.4; extra == "documentation"
37
+ Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "documentation"
38
38
  Dynamic: license-file
39
39
 
40
40
  PyMieSimX
@@ -11,10 +11,9 @@ makefile
11
11
  pyproject.toml
12
12
  pytest.ini
13
13
  .github/dependabot.yml
14
- .github/workflows/deploy_PyPi.yml
15
- .github/workflows/deploy_anaconda.yml
16
14
  .github/workflows/deploy_coverage.yml
17
15
  .github/workflows/deploy_documentation.yml
16
+ .github/workflows/deploy_release.yml
18
17
  .github/workflows/quality.yml
19
18
  .github/workflows/tests.yml
20
19
  PyMieSimX/__init__.py
@@ -85,6 +84,7 @@ PyMieSimX/gui/pages/single/sections/__init__.py
85
84
  PyMieSimX/gui/pages/single/sections/representations.py
86
85
  PyMieSimX/gui/pages/single/sections/setup.py
87
86
  conda.recipe/meta.yaml
87
+ docs/redirect.html
88
88
  docs/source/api.rst
89
89
  docs/source/conf.py
90
90
  docs/source/contributing.rst
@@ -92,6 +92,8 @@ docs/source/getting_started.rst
92
92
  docs/source/gui.rst
93
93
  docs/source/how_it_works.rst
94
94
  docs/source/index.rst
95
+ docs/source/project.rst
96
+ docs/source/reference.rst
95
97
  docs/source/sharing.rst
96
98
  docs/source/_static/favicon.svg
97
99
  docs/source/_static/logo.svg
@@ -17,10 +17,10 @@ mypy==1.15.0
17
17
  ruff==0.11.2
18
18
 
19
19
  [docs]
20
- MartinPdeS-docs>=0.1.4
20
+ MartinPdeS-docs<0.3,>=0.2.1
21
21
 
22
22
  [documentation]
23
- MartinPdeS-docs>=0.1.4
23
+ MartinPdeS-docs<0.3,>=0.2.1
24
24
 
25
25
  [testing]
26
26
  pytest>=8.0
@@ -3,10 +3,9 @@
3
3
  ".coveragerc",
4
4
  ".flake8",
5
5
  ".github/dependabot.yml",
6
- ".github/workflows/deploy_PyPi.yml",
7
- ".github/workflows/deploy_anaconda.yml",
8
6
  ".github/workflows/deploy_coverage.yml",
9
7
  ".github/workflows/deploy_documentation.yml",
8
+ ".github/workflows/deploy_release.yml",
10
9
  ".github/workflows/quality.yml",
11
10
  ".github/workflows/tests.yml",
12
11
  ".gitignore",
@@ -76,6 +75,7 @@
76
75
  "PyMieSimX/gui/validation.py",
77
76
  "README.rst",
78
77
  "conda.recipe/meta.yaml",
78
+ "docs/redirect.html",
79
79
  "docs/source/_static/favicon.svg",
80
80
  "docs/source/_static/logo.svg",
81
81
  "docs/source/api.rst",
@@ -85,6 +85,8 @@
85
85
  "docs/source/gui.rst",
86
86
  "docs/source/how_it_works.rst",
87
87
  "docs/source/index.rst",
88
+ "docs/source/project.rst",
89
+ "docs/source/reference.rst",
88
90
  "docs/source/sharing.rst",
89
91
  "makefile",
90
92
  "pyproject.toml",
@@ -0,0 +1,8 @@
1
+ {
2
+ "tag": "0.4.4",
3
+ "distance": 0,
4
+ "node": "gd743aadbd5ddcce6e4494736545d702e22ca6547",
5
+ "dirty": false,
6
+ "branch": "HEAD",
7
+ "node_date": "2026-10-21"
8
+ }
@@ -0,0 +1,13 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <meta http-equiv="refresh" content="0; url=docs/latest/index.html">
7
+ <link rel="canonical" href="docs/latest/index.html">
8
+ <title>PyMieSimX documentation</title>
9
+ </head>
10
+ <body>
11
+ <p>Continue to the <a href="docs/latest/index.html">PyMieSimX documentation</a>.</p>
12
+ </body>
13
+ </html>
@@ -1,9 +1,7 @@
1
1
  """Sphinx configuration for PyMieSimX."""
2
2
 
3
- import os
4
3
  import subprocess
5
4
  import sys
6
- from importlib.metadata import PackageNotFoundError, version as distribution_version
7
5
  from pathlib import Path
8
6
 
9
7
  from martinpdes_docs import configure
@@ -29,13 +27,6 @@ package = "PyMieSimX"
29
27
  repository = "MartinPdeS/PyMieSimX"
30
28
  author = "Martin Poinsinet de Sivry-Houle"
31
29
 
32
- try:
33
- installed_version = distribution_version(package)
34
- except PackageNotFoundError:
35
- installed_version = "latest"
36
-
37
- version = os.getenv("tag", installed_version)
38
-
39
30
  # PyMieSimX documents a stable Python API and its Dash application; it does
40
31
  # not currently have executable gallery examples.
41
32
  globals().update(
@@ -44,7 +35,6 @@ globals().update(
44
35
  package=package,
45
36
  author=author,
46
37
  repository=repository,
47
- version=version,
48
38
  logo="_static/logo.svg",
49
39
  favicon="_static/favicon.svg",
50
40
  extensions=[
@@ -18,19 +18,8 @@ from scripts and notebooks.
18
18
  getting_started
19
19
  how_it_works
20
20
  sharing
21
-
22
- .. toctree::
23
- :maxdepth: 2
24
- :caption: Reference
25
-
26
- api
27
- gui
28
-
29
- .. toctree::
30
- :maxdepth: 1
31
- :caption: Project
32
-
33
- contributing
21
+ Reference <reference>
22
+ Project <project>
34
23
 
35
24
  Key features
36
25
  ------------
@@ -0,0 +1,9 @@
1
+ Project
2
+ =======
3
+
4
+ Find guidance for sharing simulations and contributing to PyMieSimX.
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+
9
+ contributing
@@ -0,0 +1,10 @@
1
+ Reference
2
+ =========
3
+
4
+ The reference section covers the Python API and the graphical interface.
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+
9
+ api
10
+ gui
@@ -53,10 +53,10 @@ dev = [
53
53
  "ruff==0.11.2",
54
54
  ]
55
55
  docs = [
56
- "MartinPdeS-docs>=0.1.4",
56
+ "MartinPdeS-docs>=0.2.1,<0.3",
57
57
  ]
58
58
  documentation = [
59
- "MartinPdeS-docs>=0.1.4",
59
+ "MartinPdeS-docs>=0.2.1,<0.3",
60
60
  ]
61
61
 
62
62
  [tool.setuptools.packages.find]
@@ -1,17 +0,0 @@
1
- name: Publish to PyPI
2
-
3
- on:
4
- push:
5
- tags: ["v*"]
6
-
7
- permissions:
8
- contents: read
9
-
10
- jobs:
11
- publish:
12
- uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@a01969bc5af90666281f9d37acffdf6a4629763a
13
- with:
14
- python-version: "3.13"
15
- test-command: python -c "import PyMieSimX"
16
- secrets:
17
- PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
@@ -1,26 +0,0 @@
1
- # Build and publish the versioned documentation site.
2
- name: Documentation
3
-
4
- on:
5
- push:
6
- branches: ["**"]
7
- tags: ["v*"]
8
- pull_request:
9
- branches: ["master"]
10
-
11
- concurrency:
12
- group: documentation-build-${{ github.repository }}-${{ github.ref }}
13
- cancel-in-progress: true
14
-
15
- permissions:
16
- contents: write
17
- pages: write
18
- id-token: write
19
-
20
- jobs:
21
- documentation:
22
- uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@a01969bc5af90666281f9d37acffdf6a4629763a
23
- with:
24
- python-version: "3.13"
25
- package-name: "PyMieSimX"
26
- deploy-pages: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
@@ -1,8 +0,0 @@
1
- {
2
- "tag": "0.4.3",
3
- "distance": 0,
4
- "node": "gf35ae79ff04e77139b7c11a653cdf9e2728cf7ea",
5
- "dirty": false,
6
- "branch": "HEAD",
7
- "node_date": "2026-10-20"
8
- }
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes