[gen_clib_pro] Updated docs

.github/workflows/gen_clib_pro_shell_checker.yml

@@ -1,24 +1,22 @@
-name: gen_clib_pro shell checker
+name: gen_clib_pro_shell_checker
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'sh_tool/**'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'sh_tool/**'
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Check syntax script
-        id: syntax_checker
-        run: |
-           bash -n sh_tool/bin/gen_clib_pro.sh && echo ::set-output name=status::success || echo ::set-output name=status::failure
+      - uses: actions/checkout@v4
       - name: Check size script
         id: size_checker
         run: |
-          echo Checking size
-          code_line_number=$(wc -l < sh_tool/bin/gen_clib_pro.sh)
-          [[ $code_line_number -gt 300 ]] && echo ::set-output name=status::failure || echo ::set-output name=status::success
-      - name: Check on failures
-        if: steps.syntax_checker.outputs.status == 'failure' || steps.size_checker.outputs.status == 'failure'
-        run: exit 1
+          modules_ok=0
+          modules=($(find sh_tool/ -type f -name '*.sh' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_numbers=$(wc -l < "${mod}"); [[ $line_numbers -gt 300 ]]  && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo ok || exit 1

.github/workflows/gen_clib_pro_toc.yml

@@ -1,8 +1,8 @@
-name: gen_clib_pro toc
+name: gen_clib_pro_toc
 on: push
 jobs:
   generateTOC:
     name: TOC Generator
     runs-on: ubuntu-latest
     steps:
-      - uses: technote-space/toc-generator@v2
+      - uses: technote-space/toc-generator@v4

.readthedocs.yml

@@ -1,6 +1,7 @@
 version: 2
-python:
-  version: '3.7'
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
 sphinx:
   configuration: docs/source/conf.py
-formats: all

Dockerfile

@@ -1,4 +1,4 @@
-# Copyright 2017 Vladimir Roncevic <elektron.ronca@gmail.com>
+# Copyright 2017 - 2024 Vladimir Roncevic <elektron.ronca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

README.md

@@ -6,7 +6,7 @@
 
 Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.
 
-[![gen_clib_pro shell checker](https://github.com/vroncevic/gen_clib_pro/workflows/gen_clib_pro%20shell%20checker/badge.svg)](https://github.com/vroncevic/gen_clib_pro/actions?query=workflow%3A%22gen_clib_pro+shell+checker%22)
+[![gen_clib_pro_shell_checker](https://github.com/vroncevic/gen_clib_pro/actions/workflows/gen_clib_pro_shell_checker.yml/badge.svg)](https://github.com/vroncevic/gen_clib_pro/actions/workflows/gen_clib_pro_shell_checker.yml)
 
 The README is used to introduce the modules and provide instructions on
 how to install the modules, any machine dependencies it may have and any
@@ -88,8 +88,6 @@ lrwxrwxrwx 1 root root 54 Dec  5 15:26 /root/bin/gen_clib_pro -> /root/scripts/g
 
 Or You can use docker to create image/container.
 
-[![gen_clib_pro docker checker](https://github.com/vroncevic/gen_clib_pro/workflows/gen_clib_pro%20docker%20checker/badge.svg)](https://github.com/vroncevic/gen_clib_pro/actions?query=workflow%3A%22gen_clib_pro+docker+checker%22)
-
 ### Usage
 
 ```
@@ -108,13 +106,17 @@ Sun 05 Dec 2021 03:29:19 PM CET
 [check_root] Check permission for current session? [ok]
 [check_root] Done
 
-
-	                         _ _ _                       
-	  __ _  ___ _ __     ___| (_) |__    _ __  _ __ ___  
-	 / _` |/ _ \ '_ \   / __| | | '_ \  | '_ \| '__/ _ \ 
-	| (_| |  __/ | | | | (__| | | |_) | | |_) | | | (_) |
-	 \__, |\___|_| |_|  \___|_|_|_.__/  | .__/|_|  \___/ 
-	 |___/                              |_|              
+
+                                           ██ ██ ██                                     
+                                          ░██░░ ░██            ██████                   
+    █████   █████  ███████         █████  ░██ ██░██           ░██░░░██ ██████  ██████   
+   ██░░░██ ██░░░██░░██░░░██       ██░░░██ ░██░██░██████       ░██  ░██░░██░░█ ██░░░░██  
+  ░██  ░██░███████ ░██  ░██      ░██  ░░  ░██░██░██░░░██      ░██████  ░██ ░ ░██   ░██  
+  ░░██████░██░░░░  ░██  ░██      ░██   ██ ░██░██░██  ░██      ░██░░░   ░██   ░██   ░██  
+   ░░░░░██░░██████ ███  ░██ █████░░█████  ███░██░██████  █████░██     ░███   ░░██████   
+    █████  ░░░░░░ ░░░   ░░ ░░░░░  ░░░░░  ░░░ ░░ ░░░░░   ░░░░░ ░░      ░░░     ░░░░░░    
+   ░░░░░                                                                                
+
 
 		Info   github.io/gen_clib_pro ver.2.0 
 		Issue  github.io/issue
@@ -233,17 +235,17 @@ sh_tool/
 
 ### Docs
 
-[![Documentation Status](https://readthedocs.org/projects/gen_clib_pro/badge/?version=latest)](https://gen_clib_pro.readthedocs.io/projects/gen_clib_pro/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/gen_clib_pro/badge/?version=latest)](https://gen-clib-pro.readthedocs.io/projects/gen_clib_pro/en/latest/?badge=latest)
 
 More documentation and info at
-* [https://gen_clib_pro.readthedocs.io/en/latest/](https://gen_clib_pro.readthedocs.io/en/latest/)
+* [https://gen_clib_pro.readthedocs.io/en/latest/](https://gen-clib-pro.readthedocs.io/en/latest/)
 * [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)
 
 ### Copyright and licence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Copyright (C) 2017 by [vroncevic.github.io/gen_clib_pro](https://vroncevic.github.io/gen_clib_pro)
+Copyright (C) 2017 - 2024 by [vroncevic.github.io/gen_clib_pro](https://vroncevic.github.io/gen_clib_pro)
 
 **gen_clib_pro** is free software; you can redistribute it and/or modify
 it under the same terms as Bash itself, either Bash version 4.2.47 or,

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d7a0b836a39c49c110ed0a56946bb572
+config: d7f036f11f8ce48824727e7422e9ddf2
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst.txt

@@ -7,8 +7,8 @@ Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **1
 
 |GitHub shell checker|
 
-.. |GitHub shell checker| image:: https://github.com/vroncevic/gen_clib_pro/workflows/gen_clib_pro%20shell%20checker/badge.svg
-   :target: https://github.com/vroncevic/gen_clib_pro/actions?query=workflow%3A%22gen_clib_pro+shell+checker%22
+.. |GitHub shell checker| image:: https://github.com/vroncevic/gen_clib_pro/actions/workflows/gen_clib_pro_shell_checker.yml/badge.svg
+   :target: https://github.com/vroncevic/gen_clib_pro/actions/workflows/gen_clib_pro_shell_checker.yml
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
@@ -23,7 +23,7 @@ other information that should be provided before the tool is installed.
    :target: https://github.com/vroncevic/gen_clib_pro/graphs/contributors
 
 .. |Documentation Status| image:: https://readthedocs.org/projects/gen_clib_pro/badge/?version=latest
-   :target: https://gen_clib_pro.readthedocs.io/projects/gen_clib_pro/en/latest/?badge=latest
+   :target: https://gen-clib-pro.readthedocs.io/projects/gen_clib_pro/en/latest/?badge=latest
 
 .. toctree::
     :hidden:
@@ -113,7 +113,7 @@ Copyright and licence
 .. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
 
-Copyright (C) 2017 by `vroncevic.github.io/gen_clib_pro <https://vroncevic.github.io/gen_clib_pro>`_
+Copyright (C) 2017 - 2024 by `vroncevic.github.io/gen_clib_pro <https://vroncevic.github.io/gen_clib_pro>`_
 
 **gen_clib_pro** is free software; you can redistribute it and/or modify it
 under the same terms as Bash itself, either Bash version 4.2.47 or,

docs/build/html/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,134 @@
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}