Skip to content

[gen_man] Added display logo, updated code coverage, version, docs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vroncevic merged 1 commit into from
Dec 4, 2025
Merged

[gen_man] Added display logo, updated code coverage, version, docs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2017 - 2024 Vladimir Roncevic <elektron.ronca@gmail.com>
# Copyright 2017 - 2026 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.
Expand Down Expand Up @@ -35,12 +35,12 @@ RUN rm -Rf v1.0.zip sh_util-1.0
RUN mkdir /sh_tool/
COPY sh_tool /sh_tool/
RUN find /sh_tool/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
RUN mkdir -p /root/scripts/gen_man/ver.2.0/
RUN mkdir -p /root/scripts/gen_man/ver.3.0/
RUN mkdir /root/bin/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_man/ver.2.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_man/ver.2.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_man/ver.2.0/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_man/ver.3.0/
RUN rm -Rf /sh_tool/
RUN chmod -R 755 /root/scripts/gen_man/ver.2.0/
RUN ln -s /root/scripts/gen_man/ver.2.0/bin/gen_man.sh /root/bin/gen_man
RUN tree /root/scripts/gen_man/ver.2.0/
RUN chmod -R 755 /root/scripts/gen_man/ver.3.0/
RUN ln -s /root/scripts/gen_man/ver.3.0/bin/gen_man.sh /root/bin/gen_man
RUN tree /root/scripts/gen_man/ver.3.0/
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Navigate to release **[page](https://github.com/vroncevic/gen_man/releases)** do
To install **gen_man** type the following:

```bash
tar xvzf gen_man-x.y.tar.gz
cd gen_man-x.y
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.x.y/
tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/
```

![alt tag](https://raw.githubusercontent.com/vroncevic/gen_man/dev/docs/setup_tree.png)
Expand All @@ -49,7 +49,7 @@ Or You can use docker to create image/container.

```bash
# Create symlink for shell tool
ln -s /root/scripts/gen_man/ver.x.y/bin/gen_man.sh /root/bin/gen_man
ln -s /root/scripts/gen_man/ver.3.0/bin/gen_man.sh /root/bin/gen_man

# Setting PATH
export PATH=${PATH}:/root/bin/
Expand Down Expand Up @@ -97,7 +97,7 @@ More documentation and info at:

[![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 - 2024 by [vroncevic.github.io/gen_man](https://vroncevic.github.io/gen_man)
Copyright (C) 2017 - 2026 by [vroncevic.github.io/gen_man](https://vroncevic.github.io/gen_man)

**gen_man** 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,
Expand Down
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: 8e3634fbb38117f80bde87b371f78675
config: 22b75811fab0779ad40060f9433d55d4
tags: 645f666f9bcd5a90fca523b33c5a78b7
12 changes: 6 additions & 6 deletions docs/build/html/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To install **gen_man** type the following:

.. code-block:: bash

tar xvzf gen_man-x.y.tar.gz
cd gen_man-x.y
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.x.y/
tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/

Or You can use Docker to create image/container.

Expand Down Expand Up @@ -89,7 +89,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 - 2024 by `vroncevic.github.io/gen_man <https://vroncevic.github.io/gen_man>`_
Copyright (C) 2017 - 2026 by `vroncevic.github.io/gen_man <https://vroncevic.github.io/gen_man>`_

**gen_man** 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,
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
&#169; Copyright 2026, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
Expand Down
14 changes: 7 additions & 7 deletions docs/build/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ <h1>gen_man<a class="headerlink" href="#gen-man" title="Link to this heading">¶
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
<p>Navigate to release <a class="reference external" href="https://github.com/vroncevic/gen_man/releases">page</a> download and extract release archive.</p>
<p>To install <strong>gen_man</strong> type the following:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tar<span class="w"> </span>xvzf<span class="w"> </span>gen_man-x.y.tar.gz
<span class="nb">cd</span><span class="w"> </span>gen_man-x.y
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/bin/<span class="w"> </span>/root/scripts/gen_man/ver.x.y/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/conf/<span class="w"> </span>/root/scripts/gen_man/ver.x.y/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/log/<span class="w"> </span>/root/scripts/gen_man/ver.x.y/
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tar<span class="w"> </span>xvzf<span class="w"> </span>gen_man-3.0.tar.gz
<span class="nb">cd</span><span class="w"> </span>gen_man-3.0
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/bin/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/conf/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/log/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
</pre></div>
</div>
<p>Or You can use Docker to create image/container.</p>
Expand Down Expand Up @@ -86,7 +86,7 @@ <h1>Shell tool structure<a class="headerlink" href="#shell-tool-structure" title
<section id="copyright-and-licence">
<h1>Copyright and licence<a class="headerlink" href="#copyright-and-licence" title="Link to this heading">¶</a></h1>
<p><a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-GPLv3-blue.svg" /></a> <a class="reference external" href="https://opensource.org/licenses/Apache-2.0"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a></p>
<p>Copyright (C) 2017 - 2024 by <a class="reference external" href="https://vroncevic.github.io/gen_man">vroncevic.github.io/gen_man</a></p>
<p>Copyright (C) 2017 - 2026 by <a class="reference external" href="https://vroncevic.github.io/gen_man">vroncevic.github.io/gen_man</a></p>
<p><strong>gen_man</strong> 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,
at your option, any later version of Bash 4 you may have available.</p>
Expand Down Expand Up @@ -154,7 +154,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
&#169; Copyright 2026, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
Expand Down
Binary file modified docs/build/html/objects.inv
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
&#169; Copyright 2026, Vladimir Roncevic &lt;elektron.ronca@gmail.com&gt;.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Module
conf.py
Copyright
Copyright (C) 2017 - 2024-2024 Vladimir Roncevic <elektron.ronca@gmail.com>
Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
gen_man is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or
Expand All @@ -27,9 +27,9 @@
sys.path.insert(0, os.path.abspath('../../'))

project: str = 'gen_man'
project_copyright: str = '2024, Vladimir Roncevic <elektron.ronca@gmail.com>'
project_copyright: str = '2026, Vladimir Roncevic <elektron.ronca@gmail.com>'
author: str = 'Vladimir Roncevic <elektron.ronca@gmail.com>'
version: str = '2.0'
version: str = '3.0'
release: str = 'https://github.com/vroncevic/gen_man/releases'
extensions: List[str] = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
templates_path: List[str] = ['_templates']
Expand Down
12 changes: 6 additions & 6 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To install **gen_man** type the following:

.. code-block:: bash

tar xvzf gen_man-x.y.tar.gz
cd gen_man-x.y
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.x.y/
tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/

Or You can use Docker to create image/container.

Expand Down Expand Up @@ -89,7 +89,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 - 2024 by `vroncevic.github.io/gen_man <https://vroncevic.github.io/gen_man>`_
Copyright (C) 2017 - 2026 by `vroncevic.github.io/gen_man <https://vroncevic.github.io/gen_man>`_

**gen_man** 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,
Expand Down
31 changes: 0 additions & 31 deletions sh_tool/bin/center.sh
View file
Open in desktop

This file was deleted.

44 changes: 0 additions & 44 deletions sh_tool/bin/display_logo.sh
View file
Open in desktop

This file was deleted.

3 changes: 3 additions & 0 deletions sh_tool/bin/gen_man.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ UTIL_LOG=${UTIL}/log
. ${UTIL}/bin/load_conf.sh
. ${UTIL}/bin/load_util_conf.sh
. ${UTIL}/bin/progress_bar.sh
. ${UTIL}/bin/display_logo.sh

GEN_MAN_TOOL=genman
GEN_MAN_VERSION=ver.1.0
GEN_MAN_HOME=${UTIL_ROOT}/${GEN_MAN_TOOL}/${GEN_MAN_VERSION}
GEN_MAN_CFG=${GEN_MAN_HOME}/conf/${GEN_MAN_TOOL}.cfg
GEN_MAN_UTIL_CFG=${GEN_MAN_HOME}/conf/${GEN_MAN_TOOL}_util.cfg
GEN_MAN_LOGO=${GEN_MAN_HOME}/conf/${GEN_MAN_TOOL}.logo
GEN_MAN_LOG=${GEN_MAN_HOME}/log

. ${GEN_MAN_HOME}/bin/install_man.sh
Expand Down Expand Up @@ -81,6 +83,7 @@ TOOL_NOTIFY="false"
function __gen_man {
local OP=$1 MFILE=$2
if [[ -n "${OP}" && -n "${MFILE}" ]]; then
display_logo "vroncevic" "${GEN_MAN_TOOL}" "${GEN_MAN_VERSION}" "${GEN_MAN_LOGO}"
local FUNC=${FUNCNAME[0]} MSG="None"
local STATUS_CONF STATUS_CONF_UTIL STATUS
MSG="Loading basic and util configuration!"
Expand Down