From 6d7411693eaa479d85997f6acf04e7b219f9dae8 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 00:31:07 +0000 Subject: [PATCH 1/7] update installation doc mkdocs options fix jenkins --- Jenkinsfile | 2 +- docs-static/usage.md | 15 +++--- helpers/doc_gen.py | 1 + mkdocs.yml | 125 +++++++++++++++++++++++++------------------ pyproject.toml | 2 +- 5 files changed, 85 insertions(+), 60 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 454b119..291464d 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -560,7 +560,7 @@ pipeline { 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()) } } diff --git a/docs-static/usage.md b/docs-static/usage.md index 123d6e4..bbccb24 100644 --- a/docs-static/usage.md +++ b/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--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--py3-none-any.whl -From public repository: - - TBD ## Import in your project diff --git a/helpers/doc_gen.py b/helpers/doc_gen.py index 16774b1..0f9f875 100644 --- a/helpers/doc_gen.py +++ b/helpers/doc_gen.py @@ -105,6 +105,7 @@ class doc_gen(helper_withresults_base): ), "verbose": False, "media_type": "print", + "render_js": True, "exclude_pages": ["LICENSE"], "output_path": str(site_path / "pdf" / "manual.pdf"), } diff --git a/mkdocs.yml b/mkdocs.yml index a0a39f4..d02be53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,62 +1,83 @@ -# 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 . - - 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 +repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper' use_directory_urls: false +copyright: Copyright © 2016 - 2023 chacha 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 + - 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.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.keys + - pymdownx.mark + - pymdownx.progressbar + - pymdownx.smartsymbols + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + - footnotes \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index eaef86a..5a1bb17 100644 --- a/pyproject.toml +++ b/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"] #[project.scripts] #my-script = "my_package.module:function" -- 2.47.3 From 72e43e7c1c2f363458f870e38e44eeec7d6847fa Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 00:42:21 +0000 Subject: [PATCH 2/7] disable mermaid/markdown --- Jenkinsfile | 1 + mkdocs.yml | 5 ----- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 291464d..42600dd 100644 --- a/Jenkinsfile +++ b/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") } } diff --git a/mkdocs.yml b/mkdocs.yml index d02be53..6d4f9c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,11 +68,6 @@ markdown_extensions: anchor_linenums: true line_spans: __span pygments_lang_class: true - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.keys - pymdownx.mark - pymdownx.progressbar -- 2.47.3 From 4fc9032cd0b3881df48c2d5c9107e802bac03b04 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 01:15:13 +0000 Subject: [PATCH 3/7] test --- helpers/doc_gen.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/helpers/doc_gen.py b/helpers/doc_gen.py index 0f9f875..790cf27 100644 --- a/helpers/doc_gen.py +++ b/helpers/doc_gen.py @@ -105,7 +105,7 @@ class doc_gen(helper_withresults_base): ), "verbose": False, "media_type": "print", - "render_js": True, + "headless_chrome_path": "chromium", "exclude_pages": ["LICENSE"], "output_path": str(site_path / "pdf" / "manual.pdf"), } diff --git a/pyproject.toml b/pyproject.toml index 5a1bb17..2fb59fa 100644 --- a/pyproject.toml +++ b/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","pymdown-extensions>=9"] +doc-gen = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-pdf-export-plugin","pyyaml>=6.0","pymdown-extensions>=9"] #[project.scripts] #my-script = "my_package.module:function" -- 2.47.3 From fe0bb13d862dd1e98b5b51d313f2007377e97b89 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 01:18:28 +0000 Subject: [PATCH 4/7] revert yo mkdocs-with-pdf --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 2fb59fa..5a1bb17 100644 --- a/pyproject.toml +++ b/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-pdf-export-plugin","pyyaml>=6.0","pymdown-extensions>=9"] +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"] #[project.scripts] #my-script = "my_package.module:function" -- 2.47.3 From e13561007b2d1423e851cdc07ab13cd022e984f3 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 01:30:17 +0000 Subject: [PATCH 5/7] add mermaid2 and markdownextradata doc exts --- mkdocs.yml | 12 +++++++++--- pyproject.toml | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 6d4f9c4..f39751d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,10 +2,10 @@ docs_dir: docs site_name: pygitversionhelper site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/' site_description: pygitversionhelper -site_author: chacha +site_author: ChaCha repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper' use_directory_urls: false -copyright: Copyright © 2016 - 2023 chacha +copyright: CC BY-NC-SA 4.0 theme: name: material features: @@ -32,6 +32,8 @@ theme: name: Switch to dark mode plugins: - search + - markdownextradata + - mermaid2 - localsearch - autorefs - mkdocstrings: @@ -75,4 +77,8 @@ markdown_extensions: - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde - - footnotes \ No newline at end of file + - footnotes + +extra: + branch: master + repository: pygitversionhelper \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 5a1bb17..d12dfe8 100644 --- a/pyproject.toml +++ b/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","pymdown-extensions>=9"] +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" -- 2.47.3 From 99ee668fe0165c6e346faf729147751fc7b76a4e Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 01:34:07 +0000 Subject: [PATCH 6/7] add mermaid --- mkdocs.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index f39751d..5e89099 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,6 +64,12 @@ markdown_extensions: - pymdownx.caret - pymdownx.critic - pymdownx.details + - pymdownx.superfences: + # make exceptions to highlighting of code: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.highlight: -- 2.47.3 From 7fa5de67a6b5e5f0eec7a7ba34b1392d11a51c86 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 08:52:17 +0000 Subject: [PATCH 7/7] remove mermaid caus pyaml is having issue.. --- mkdocs.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5e89099..f39751d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,12 +64,6 @@ markdown_extensions: - pymdownx.caret - pymdownx.critic - pymdownx.details - - pymdownx.superfences: - # make exceptions to highlighting of code: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.highlight: -- 2.47.3