Skip to content

Commit

Permalink
[atmanager] Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vroncevic committed Dec 17, 2023
1 parent 668dcdd commit 661c523
Show file tree
Hide file tree
Showing 54 changed files with 14,572 additions and 16,864 deletions.
20 changes: 0 additions & 20 deletions .github/workflows/atmanager_docker_checker.yml

This file was deleted.

21 changes: 10 additions & 11 deletions .github/workflows/atmanager_shell_checker.yml
@@ -1,23 +1,22 @@
name: atmanager shell checker
name: atmanager_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/atmanager.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/atmanager.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
4 changes: 2 additions & 2 deletions .github/workflows/atmanager_toc.yml
@@ -1,8 +1,8 @@
name: atmanager toc
name: atmanager_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
9 changes: 5 additions & 4 deletions .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
configuration: docs/source/conf.py
8 changes: 4 additions & 4 deletions Dockerfile
@@ -1,4 +1,4 @@
# Copyright 2016 Vladimir Roncevic <elektron.ronca@gmail.com>
# Copyright 2016 - 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.
Expand All @@ -13,7 +13,7 @@
# limitations under the License.
#

FROM debian:10
FROM debian:12
RUN apt-get update
RUN DEBIAN_FRONTEND=noninteractive \
apt-get install -yq --no-install-recommends \
Expand All @@ -39,8 +39,8 @@ RUN chown -R tomcat /opt/tomcat/webapps/
RUN chown -R tomcat /opt/tomcat/work/
RUN chown -R tomcat /opt/tomcat/temp/
RUN chown -R tomcat /opt/tomcat/logs/
RUN wget https://github.com/vroncevic/sh_util/archive/v1.0.zip
RUN unzip v1.0.zip
RUN wget https://github.com/vroncevic/sh_util/archive/1.0.zip
RUN unzip 1.0.zip
RUN find /sh_util-1.0/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
RUN mkdir -p /root/scripts/sh_util/ver.1.0/
RUN cp -R /sh_util-1.0/sh_tool/bin/ /root/scripts/sh_util/ver.1.0/
Expand Down
23 changes: 12 additions & 11 deletions README.md
Expand Up @@ -6,7 +6,7 @@

Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.

[![atmanager shell checker](https://github.com/vroncevic/atmanager/workflows/atmanager%20shell%20checker/badge.svg)](https://github.com/vroncevic/atmanager/actions?query=workflow%3A%22atmanager+shell+checker%22)
[![atmanager_shell_checker](https://github.com/vroncevic/atmanager/actions/workflows/atmanager_shell_checker.yml/badge.svg)](https://github.com/vroncevic/atmanager/actions/workflows/atmanager_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
Expand Down Expand Up @@ -74,8 +74,6 @@ lrwxrwxrwx 1 root root 48 Nov 21 12:13 /root/bin/atmanager -> /root/scripts/atma

Or You can use docker to create image/container.

[![atmanager docker checker](https://github.com/vroncevic/atmanager/workflows/atmanager%20docker%20checker/badge.svg)](https://github.com/vroncevic/atmanager/actions?query=workflow%3A%22atmanager+docker+checker%22)

### Usage

```
Expand All @@ -94,13 +92,16 @@ Sun 21 Nov 2021 12:13:08 PM CET
[check_root] Check permission for current session? [ok]
[check_root] Done
_
__ _| |_ _ __ ___ __ _ _ __ __ _ __ _ ___ _ __
/ _` | __| '_ ` _ \ / _` | '_ \ / _` |/ _` |/ _ \ '__|
| (_| | |_| | | | | | (_| | | | | (_| | (_| | __/ |
\__,_|\__|_| |_| |_|\__,_|_| |_|\__,_|\__, |\___|_|
|___/
██
░██
██████ ██████ ██████████ ██████ ███████ ██████ █████ █████ ██████
░░░░░░██ ░░░██░ ░░██░░██░░██ ░░░░░░██ ░░██░░░██ ░░░░░░██ ██░░░██ ██░░░██░░██░░█
███████ ░██ ░██ ░██ ░██ ███████ ░██ ░██ ███████ ░██ ░██░███████ ░██ ░
██░░░░██ ░██ ░██ ░██ ░██ ██░░░░██ ░██ ░██ ██░░░░██ ░░██████░██░░░░ ░██
░░████████ ░░██ ███ ░██ ░██░░████████ ███ ░██░░████████ ░░░░░██░░██████░███
░░░░░░░░ ░░ ░░░ ░░ ░░ ░░░░░░░░ ░░░ ░░ ░░░░░░░░ █████ ░░░░░░ ░░░
░░░░░
Info github.io/atmanager ver.4.0
Issue github.io/issue
Expand Down Expand Up @@ -179,7 +180,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) 2016 by [vroncevic.github.io/atmanager](https://vroncevic.github.io/atmanager)
Copyright (C) 2016 - 2024 by [vroncevic.github.io/atmanager](https://vroncevic.github.io/atmanager)

**atmanager** 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
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 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: 697e8f2108a9b3b8e0a36aff3fee5be9
config: b0255e92ac59bc24bba04a58341ec3b5
tags: 645f666f9bcd5a90fca523b33c5a78b7
11 changes: 3 additions & 8 deletions docs/build/html/_sources/index.rst.txt
Expand Up @@ -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/atmanager/workflows/atmanager%20shell%20checker/badge.svg
:target: https://github.com/vroncevic/atmanager/actions?query=workflow%3A%22atmanager+shell+checker%22
.. |GitHub shell checker| image:: https://github.com/vroncevic/atmanager/actions/workflows/atmanager_shell_checker.yml/badge.svg
:target: https://github.com/vroncevic/atmanager/actions/workflows/atmanager_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
Expand Down Expand Up @@ -54,11 +54,6 @@ To install **atmanager** type the following
Or You can use Docker to create image/container.

|GitHub docker checker|

.. |GitHub docker checker| image:: https://github.com/vroncevic/atmanager/workflows/atmanager%20docker%20checker/badge.svg
:target: https://github.com/vroncevic/atmanager/actions?query=workflow%3A%22atmanager+docker+checker%22

Dependencies
-------------

Expand Down Expand Up @@ -98,7 +93,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) 2016 by `vroncevic.github.io/atmanager <https://vroncevic.github.io/atmanager>`_
Copyright (C) 2016 - 2024 by `vroncevic.github.io/atmanager <https://vroncevic.github.io/atmanager>`_

**atmanager** 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
134 changes: 134 additions & 0 deletions 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;
}

0 comments on commit 661c523

Please sign in to comment.