add mermaid2 and markdownextradata doc exts

mkdocs options
fix jenkins

Jenkinsfile

@@ -147,6 +147,7 @@ pipeline {
                 }
                 sh("git config --global user.email $_MaintainerEmail")
                 sh("git config --global user.name  $_MaintainerName")	
+                sh("git config --global init.defaultBranch master")
                 
 			}
 		}
@@ -557,10 +558,10 @@ pipeline {
 									 """.stripMargin())
 									}
                        if((_GIT_BRANCH=="master") && (bPushMasterOnPypi)) {
-                           withCredentials([string( credentialsId: _PypiCredentials, passwordVariable: 'PYPI_PASSWORD', usernameVariable: 'PYPI_USERNAME')]) {
+                           withCredentials([usernamePassword( credentialsId: _PypiCredentials, passwordVariable: 'PYPI_PASSWORD', usernameVariable: 'PYPI_USERNAME')]) {
                             sh(script:   """#!/bin/sh -
                                             |. ~/TOOLS_ENV/bin/activate
-                                            |exec twine twine upload -r ${PY_PROJECT_NAME} dist/* -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --non-interactive --disable-progress-bar 
+                                            |exec twine upload -r ${PY_PROJECT_NAME} dist/* -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --non-interactive --disable-progress-bar 
                                          """.stripMargin())
 						    }
 					    }

docs-static/usage.md

@@ -2,17 +2,20 @@
 
 ## Installation
 
-From master repository:
+From pypi repository (prefered):
+
+    python -m pip install pygitversionhelper
+    
+From downloaded .whl file:
+
+    python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
+    
+From master git repository:
 
     python -m pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master
 
-From local .whl file:
 
-    python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
 
-From public repository:
-
-    TBD
 
 ## Import in your project
 

helpers/doc_gen.py

@@ -105,6 +105,7 @@ class doc_gen(helper_withresults_base):
                             ),
                             "verbose": False,
                             "media_type": "print",
+                            "headless_chrome_path": "chromium",
                             "exclude_pages": ["LICENSE"],
                             "output_path": str(site_path / "pdf" / "manual.pdf"),
                         }

mkdocs.yml

@@ -1,62 +1,84 @@
-# pyChaChaDummyProject (c) by chacha
-#
-# pyChaChaDummyProject is licensed under a
-# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
-#
-# You should have received a copy of the license along with this
-# work.  If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
-
-
 docs_dir: docs
 site_name: pygitversionhelper
-site_url: https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/
+site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/'
 site_description: pygitversionhelper
-site_author: chacha
-repo_url: https://chacha.ddns.net/gitea/chacha/pygitversionhelper
+site_author: ChaCha
+repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper'
 use_directory_urls: false
+copyright: CC BY-NC-SA 4.0
 theme:
   name: material
   features:
-  - navigation.instant
-  - navigation.tracking
-  - navigation.tabs
-  - navigation.tabs.sticky
-  - toc.integrate
-  - navigation.top
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - toc.integrate
+    - navigation.top
   palette:
-  - media: '(prefers-color-scheme: dark)'
-    scheme: slate
-    toggle:
-      icon: material/brightness-4
-      name: Switch to system preference
-  - media: (prefers-color-scheme)
-    toggle:
-      icon: material/brightness-auto
-      name: Switch to light mode
-  - media: '(prefers-color-scheme: light)'
-    scheme: default
-    toggle:
-      icon: material/brightness-7
-      name: Switch to dark mode
+    - media: '(prefers-color-scheme: dark)'
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+    - media: (prefers-color-scheme)
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: '(prefers-color-scheme: light)'
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
 plugins:
-- search
-- localsearch
-- autorefs
-- mkdocstrings:
-    default_handler: python
-    handlers:
-      python:
-        selection:
-          filters:
-          - '!^_(?!_init__)'
-          inherited_members: true
-        rendering:
-          show_root_heading: false
-          show_root_toc_entry: false
-          show_root_full_path: false
-          show_if_no_docstring: true
-          show_signature_annotations: true
-          show_source: false
-          heading_level: 2
-          group_by_category: true
-          show_category_heading: true
+  - search
+  - markdownextradata
+  - mermaid2
+  - localsearch
+  - autorefs
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          selection:
+            filters:
+              - '!^_(?!_init__)'
+            inherited_members: true
+          rendering:
+            show_root_heading: false
+            show_root_toc_entry: false
+            show_root_full_path: false
+            show_if_no_docstring: true
+            show_signature_annotations: true
+            show_source: false
+            heading_level: 2
+            group_by_category: true
+            show_category_heading: true
+markdown_extensions:
+  - def_list
+  - tables
+  - attr_list
+  - abbr
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.progressbar
+  - pymdownx.smartsymbols
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - footnotes
+
+extra:
+  branch: master
+  repository: pygitversionhelper

pyproject.toml

@@ -59,7 +59,7 @@ test              = ["junitparser>=2.8","junit2html>=30.1","xmlrunner>=1.7","myp
 coverage-check    = ["coverage>=7.0"]
 quality-check     = ["pylint>=2.15","pylint-json2html>=0.4","pandas>=1.5"]
 type-check        = ["mypy[reports]>=0.99" ]
-doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0"]
+doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"]
 
 #[project.scripts]
 #my-script = "my_package.module:function"