Add Social Cards Plugin and Minor Fiexes (#6)

Author: idapena

.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:

.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"
 

docs/index.md

@@ -1,10 +1,11 @@
 ---
+title: Welcome to PyORlib
 hide:
   - navigation
 ---
 
 <style>
-    .md-content .md-content__inner.md-typeset h1 { height: 0; margin: 0; color: transparent; }
+    .md-content .md-content__inner.md-typeset h1 { height: 0; margin: 0; color: transparent; display: none; }
     .md-content .md-content__inner.md-typeset::before { height: 0; } 
 </style>
 

docs/release-notes.md

@@ -12,6 +12,23 @@ hide:
 
 [//]: # (--------------------------------------------------------------------------------------------------------------)
 
+## [v0.1.2](https://github.com/dapensoft/pyorlib/releases/tag/0.1.2) <small>April 9, 2024</small> { id="0.1.2" }
+
+<hr class="divider">
+
+##### 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) <small>March 2, 2024</small> { id="0.1.1" }
 
 <hr class="divider">

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
 

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]",
 ]
 
 # --------------------

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