Merge pull request 'fix doc gen' (#7) from dev into master

Reviewed-on: https://chacha.ddns.net/gitea/chacha/chacha_cicd_helper/pulls/7
new-tag:0.2.2

docs-static/usage.md

@@ -1,8 +1,12 @@
 # Usage
 
-```
-> <python_bin> -m chacha_cicd_helper -h
-> usage: chacha-cicd-helper [-pp PROJECTPATH] [-tc] [-ut] [-cc] [-qc] [-dg] [-pdf] [-cpc] [-h]
+/// note
+This helper aim to be used by pychachadummyproject template instantiation.
+///
+
+```console
+/> <python_bin> -m chacha_cicd_helper -h
+usage: chacha-cicd-helper [-pp PROJECTPATH] [-tc] [-ut] [-cc] [-qc] [-dg] [-pdf] [-cpc] [-h]
 
 A bundle of cicd helper tools
 
@@ -18,7 +22,8 @@ optional arguments:
   -cpc, --complexitycheck
                         enable complexity check
   -h, --help            show this help message and exit
-  ```
+```
+
 
 Calling those commands will create a directory called `helpers-results` in `<PROJECTPATH>`  (or in the current directory).
 
@@ -35,6 +40,6 @@ This directory will contain some of the following subdirectory, depending on wha
 | cl_unit_test_coverage | unit test coverage reports                  |
 | cl_unit_test_full     | full unitest report (merged)                |
 
-> Note: <docgen> needs a docs-static directory in the target project root. Then one can put any .md file inside.
-
-> Note: This helper aim to be used by pychachadummyproject template instantiation.
+/// warning
+ <docgen> needs a docs-static directory in the target project root. Then one can put any .md file inside.
+///

mkdocs.yml

@@ -1,11 +1,11 @@
 docs_dir: docs
-site_name: 'chacha_cicd_helper'
-site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/chacha_cicd_helper/latest/'
-site_description: 'A bundle of cicd helper tools'
-site_author: 'chacha'
-repo_url: 'https://chacha.ddns.net/gitea/chacha/chacha_cicd_helper'
+site_name: chacha_cicd_helper
+site_url: https://chacha.ddns.net/mkdocs-web/chacha/chacha_cicd_helper/latest/
+site_description: A bundle of cicd helper tools
+site_author: chacha
+repo_url: https://chacha.ddns.net/gitea/chacha/chacha_cicd_helper
 use_directory_urls: false
-copyright: 'CC BY-NC-SA 4.0'
+copyright: CC BY-NC-SA 4.0
 theme:
   name: material
   features:
@@ -59,6 +59,13 @@ plugins:
           heading_level: 2
           docstring_section_style: spacy
           show_root_toc_entry: false
+- with-pdf:
+    cover_subtitle: User Manual
+    cover_logo: C:\Users\chacha\git\chacha_cicd_helper\docs-static\Library.jpg
+    verbose: false
+    exclude_pages:
+    - LICENSE
+    output_path: C:\Users\chacha\git\chacha_cicd_helper\helpers-results\doc_gen\site\pdf\manual.pdf
 markdown_extensions:
 - def_list
 - tables