diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index be6fbea..cbc7efb 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -21,9 +21,9 @@ jobs: run: | git config user.name github-actions[bot] git config user.email 41898282+github-actions[bot]@users.noreply.github.com - - uses: actions/setup-python@v4 + - uses: actions/setup-python@v5 with: - python-version: "3.10" + python-version: "3.11" - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV - uses: actions/cache@v3 with: diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml index 7f34d2f..19b2668 100644 --- a/.github/workflows/publish-to-pypi.yml +++ b/.github/workflows/publish-to-pypi.yml @@ -15,7 +15,7 @@ jobs: uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.x" diff --git a/docs/index.md b/docs/index.md index 9924f0c..66308c8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,11 @@ --- +title: Welcome to PyORlib hide: - navigation --- diff --git a/docs/release-notes.md b/docs/release-notes.md index 1f4f4da..14254b3 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -12,6 +12,23 @@ hide: [//]: # (--------------------------------------------------------------------------------------------------------------) +## [v0.1.2](https://github.com/dapensoft/pyorlib/releases/tag/0.1.2) April 9, 2024 { id="0.1.2" } + +
+ +##### Changed + +- Upgraded the `Setup-Python` GitHub Action from version 4 to version 5 in all workflows. +- Updated the `index.md` page with a welcome title. +- Updated the `mkdocs.yml` config file with the `mkdocs social cards` plugin. +- Updated the `pyproject.toml` config file with the necessary dependencies for the `mkdocs social cards` plugin. + +##### Fixed + +- Resolved the `mathjax.js` config file path error in the documentation. + +[//]: # (--------------------------------------------------------------------------------------------------------------) + ## [v0.1.1](https://github.com/dapensoft/pyorlib/releases/tag/0.1.1) March 2, 2024 { id="0.1.1" }
diff --git a/mkdocs.yml b/mkdocs.yml index 5146161..ab055f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,8 +64,8 @@ plugins: repository: dapensoft/pyorlib branch: master exclude: + - api/* - examples/index.md - - api/index.md - index.md - git-revision-date-localized: type: timeago @@ -91,6 +91,8 @@ plugins: show_symbol_type_toc: true show_signature_annotations: true show_category_heading: true + - social: + enabled: !ENV [ CI, false ] # Extensions markdown_extensions: @@ -122,7 +124,7 @@ markdown_extensions: # Extra JavaScript for MathJax extra_javascript: - - javascripts/mathjax.js + - javascript/mathjax.js - https://polyfill.io/v3/polyfill.min.js?features=es6 - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js diff --git a/pyproject.toml b/pyproject.toml index b2ac0c1..5136b3d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,10 +63,11 @@ all = [ # ---------- docs = [ - "mkdocs-material>=9.4.0", + "mkdocs-material>=9.5.17", "mkdocstrings[python]>=0.24.0", "mkdocs-git-revision-date-localized-plugin>=1.2.1", "mkdocs-git-committers-plugin-2>=2.3.0", + "mkdocs-material[imaging]", ] # -------------------- diff --git a/src/pyorlib/__init__.py b/src/pyorlib/__init__.py index 7a24112..ab5a43d 100644 --- a/src/pyorlib/__init__.py +++ b/src/pyorlib/__init__.py @@ -3,7 +3,7 @@ mathematical models in a standardized manner across different optimization packages. """ -__version__ = "0.1.1" +__version__ = "0.1.2" from .engines import Engine from .model import Model