fix: try to fix doc

.settings/org.eclipse.core.resources.prefs

@@ -1,3 +1,10 @@
 eclipse.preferences.version=1
+encoding//src/pygamecfg/__init__.py=utf-8
 encoding//src/pygamecfg/__main__.py=utf-8
+encoding//src/pygamecfg/common_ut.py=utf-8
+encoding//src/pygamecfg/core.py=utf-8
+encoding//src/pygamecfg/game_cod4.py=utf-8
+encoding//src/pygamecfg/game_ut2k4.py=utf-8
+encoding//src/pygamecfg/game_ut99.py=utf-8
+encoding//src/pygamecfg/tool_ini.py=utf-8
 encoding/<project>=UTF-8

README.md

@@ -8,46 +8,8 @@
 
 ![](docs-static/Library.jpg)
 
-# Python project template
+# pyGameCFG
 
-A nice template to start blank python projets.
- 
-This template automate a lot of handy things and allow CI/CD automatic releases generation.
-
-It is also collectings data to feed Jenkins build.
 
 Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/{{repository}}/{{branch}}/latest/).
 
-## Features
-
-### Generic pipeline skeleton:
-    - Prepare
-    - GetCode
-    - BuildPackage
-    - Install
-    - CheckCode
-    - PlotMetrics
-    - RunUnitTests
-    - GenDOC
-    - PostRelease
-    
-### CI/CD Environment
-    - Jenkins
-    - Gitea (with patch for dynamic Readme variables: https://chacha.ddns.net/gitea/chacha/GiteaMarkupVariable)
-    - Docker
-    - MkDocsWeb
-    
-### CI/CD Helper libs
-    - VirtualEnv
-    - Changelog generation based on commits
-    - copier
-    - pylint + pylint_json2html
-    - mypy
-    - unittest + xmlrunner + junitparser + junit2htmlreport
-    - mkdocs
-
-### Python project
-    - Full .toml implementation
-    - .whl automatic generation
-    - dynamic versionning using git repository
-    - embedded unit-test

docs-static/usage.md

@@ -1,16 +1 @@
-# Usage
-
-## Pulvinar dolor
-Donec dapibus est fermentum justo volutpat condimentum. Integer quis nunc neque. Donec dictum vehicula justo, in facilisis ex tincidunt in. 
-Vivamus sollicitudin sem dui, id mollis orci facilisis ut. Proin sed pulvinar dolor. Donec volutpat commodo urna imperdiet pulvinar. Fusce eget aliquam risus. 
-Vivamus viverra luctus ex, in finibus mi. Nullam elementum dapibus mollis. Ut suscipit volutpat ex, quis feugiat lacus consectetur eu. 
-
-## Condimentum faucibus
-Quisque auctor egestas sem, luctus suscipit ex maximus vitae. Duis facilisis augue et condimentum faucibus. 
-Donec cursus, enim a sagittis egestas, lectus lorem eleifend libero, at tincidunt leo magna at libero. 
-Nunc eros velit, suscipit luctus tempor vel, finibus et est. Curabitur efficitur pretium pulvinar. 
-Donec urna lectus, vulputate quis turpis sed, placerat congue urna. Phasellus aliquet fermentum quam, non auctor elit porta nec. Morbi eu ligula at nisl ultricies condimentum vitae id ante. 
-
-## Aliquam lacinia
-In volutpat lorem ex, et fringilla nibh faucibus quis. Mauris et arcu elementum, auctor dui vitae, egestas arcu. Duis sit amet aliquam quam. 
-Phasellus a odio turpis. Etiam tristique mi eu enim varius, eget facilisis est vestibulum. Aliquam lacinia nec purus sed luctus. Cras at laoreet erat. 
+# Usage

mkdocs.yml

@@ -1,19 +1,12 @@
-# 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: 'pygamecfg'
-site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygamecfg/latest/'
-site_description: 'A simple game config tool that provide bash API to read / write game config files (cod, ut ...)'
-site_author: 'chacha'
-repo_url: 'https://chacha.ddns.net/gitea/chacha/pygamecfg'
+site_name: pygamecfg
+site_url: https://chacha.ddns.net/mkdocs-web/chacha/pygamecfg/latest/
+site_description: A simple game config tool that provide bash API to read / write
+  game config files (cod, ut ...)
+site_author: chacha
+repo_url: https://chacha.ddns.net/gitea/chacha/pygamecfg
 use_directory_urls: false
-copyright: 'CC BY-NC-SA 4.0'
+copyright: CC BY-NC-SA 4.0
 theme:
   name: material
   features:
@@ -44,17 +37,21 @@ theme:
       icon: material/brightness-7
       name: Switch to dark mode
 plugins:
+- localsearch
 - search
+- autorefs
 - markdownextradata
 - mermaid2
-- localsearch
 - mkdocstrings:
     default_handler: python
     handlers:
       python:
+        paths:
+        - src
         options:
           filters:
           - '!^_[^_]'
+          docstring_style: google
           inherited_members: true
           show_if_no_docstring: true
           show_signature_annotations: true
@@ -65,6 +62,13 @@ plugins:
           show_root_full_path: false
           merge_init_into_class: true
           separate_signature: true
+- with-pdf:
+    cover_subtitle: User Manual
+    cover_logo: C:\Users\chacha\git\pygamecfg\docs-static\Library.jpg
+    verbose: false
+    exclude_pages:
+    - LICENSE
+    output_path: C:\Users\chacha\git\pygamecfg\helpers-results\doc_gen\site\pdf\manual.pdf
 markdown_extensions:
 - def_list
 - tables
@@ -115,4 +119,4 @@ markdown_extensions:
     emoji_generator: !!python/name:materialx.emoji.to_svg
 extra:
   branch: master
-  repository: pygitversionhelper
+  repository: pygamecfg

pyproject.toml

@@ -61,8 +61,8 @@ coverage-check    = ["coverage>=7.0"]
 complexity-check  = ["radon>=5.1"]
 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-pymdownx-material-extras", "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"]
+doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5","mkdocs-material-extensions","mkdocs-pymdownx-material-extras", "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","mkdocs-autorefs"]
 
-#[project.scripts]
-#my-script = "my_package.module:function"
+# [project.scripts]
+# my-script = "my_package.module:function"
 

src/pygamecfg/__init__.py

@@ -1,6 +1,9 @@
-# pygamecfg (c) by chacha
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
 #
-# pygamecfg  is licensed under a
+# pyGameCFG  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

src/pygamecfg/__main__.py

@@ -1,12 +1,14 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# PySimpleINI (c) by chacha
+
+# pyGameCFG(c) by chacha
 #
-# PySimpleINI  is licensed under a
+# pyGameCFG  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/>.
+
 """CLI interface module"""
 from __future__ import annotations
 from typing import Literal, cast, Union

src/pygamecfg/common_ut.py

@@ -1,3 +1,14 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
 """common UT functions"""
 from __future__ import annotations
 from typing import Union

src/pygamecfg/core.py

@@ -1,3 +1,14 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
 """ Core file of pygamecfg
 contain generic management code for GameOption
 """
@@ -29,6 +40,16 @@ class GameOption(metaclass=ABCMeta):
     szFormatedValue: str = ""
 
     def __init__(self, GameRootDir: str, ConfigFileRelPath: Union[None, str] = None):
+        """GameOption constructor.
+
+        ///warning
+        This object does not aim to be created
+        ///
+
+        Args:
+            GameRootDir: root dir of the game
+            ConfigFileRelPath: path to the configfile (relative to rootdir)
+        """
         self.GameRootDir = GameRootDir
         self.ConfigFileRelPath = ConfigFileRelPath
 

src/pygamecfg/game_cod4.py

@@ -1,3 +1,14 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
 # pylint: disable=missing-class-docstring,missing-module-docstring,missing-function-docstring,duplicate-code
 from __future__ import annotations
 from typing import Union

src/pygamecfg/game_ut2k4.py

@@ -1,4 +1,16 @@
-# pylint: disable=missing-class-docstring,missing-module-docstring,missing-function-docstring,duplicate-code
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
+# pylint: disable=missing-class-docstring,missing-function-docstring,duplicate-code
+"""UT2k4 command set"""
 from __future__ import annotations
 from typing import Union
 

src/pygamecfg/game_ut99.py

@@ -1,4 +1,16 @@
-# pylint: disable=missing-class-docstring,missing-module-docstring,missing-function-docstring,duplicate-code
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
+# pylint: disable=missing-class-docstring,missing-function-docstring,duplicate-code
+"""UT99 command set"""
 from __future__ import annotations
 from typing import Union
 

src/pygamecfg/tool_ini.py

@@ -1,3 +1,14 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# pyGameCFG(c) by chacha
+#
+# pyGameCFG  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/>.
+
 """utility module that contain PySimpleINI based helpers"""
 from __future__ import annotations
 from typing import Union