Skip to content

Commit

Permalink
Merge pull request #11 from vroncevic/dev
Browse files Browse the repository at this point in the history
[check_mysqldb] Updated docs
  • Loading branch information
vroncevic committed Oct 20, 2020
2 parents 444fde3 + 427842d commit 509b6cf
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 11 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ other information that should be provided before the tool is installed.

### Installation

Navigate to release [page](https://github.com/vroncevic/check_mysqldb/releases) download and extract release archive.
Navigate to release **[page](https://github.com/vroncevic/check_mysqldb/releases)** download and extract release archive.

To install **check_mysqldb** type the following:

Expand Down Expand Up @@ -96,3 +96,8 @@ Copyright (C) 2016 by [vroncevic.github.io/check_mysqldb](https://vroncevic.gith
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.

Lets help and support FSF.

[![Free Software Foundation](https://raw.githubusercontent.com/vroncevic/check_mysqldb/dev/docs/fsf-logo_1.png)](https://my.fsf.org/)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://my.fsf.org/donate/)
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
23 changes: 21 additions & 2 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,15 @@ Dependencies
-------------

**check_mysqldb** requires next modules and libraries:
sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

* sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

Shell tool structure
---------------------

**check_mysqldb** is based on MOP.

Shell tool structure:
Code structure:

.. code-block:: bash
Expand Down Expand Up @@ -95,3 +96,21 @@ Copyright (C) 2016 by `vroncevic.github.io/check_mysqldb <https://vroncevic.gith
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.

Lets help and support FSF.

|Free Software Foundation|

.. |Free Software Foundation| image:: https://raw.githubusercontent.com/vroncevic/check_mysqldb/dev/docs/fsf-logo_1.png
:target: https://my.fsf.org/

|Donate|

.. |Donate| image:: https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif
:target: https://my.fsf.org/donate/

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
21 changes: 16 additions & 5 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,15 +175,15 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
</div>
<div class="section" id="dependencies">
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h1>
<dl class="docutils">
<dt><strong>check_mysqldb</strong> requires next modules and libraries:</dt>
<dd>sh_util <a class="reference external" href="https://github.com/vroncevic/sh_util">https://github.com/vroncevic/sh_util</a></dd>
</dl>
<p><strong>check_mysqldb</strong> requires next modules and libraries:</p>
<ul class="simple">
<li>sh_util <a class="reference external" href="https://github.com/vroncevic/sh_util">https://github.com/vroncevic/sh_util</a></li>
</ul>
</div>
<div class="section" id="shell-tool-structure">
<h1>Shell tool structure<a class="headerlink" href="#shell-tool-structure" title="Permalink to this headline"></a></h1>
<p><strong>check_mysqldb</strong> is based on MOP.</p>
<p>Shell tool structure:</p>
<p>Code structure:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>.
├── bin/
│ └── check_mysqldb.sh
Expand All @@ -202,6 +202,17 @@ <h1>Copyright and licence<a class="headerlink" href="#copyright-and-licence" tit
<p><strong>check_mysqldb</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>
<p>Lets help and support FSF.</p>
<p><a class="reference external" href="https://my.fsf.org/"><img alt="Free Software Foundation" src="https://raw.githubusercontent.com/vroncevic/check_mysqldb/dev/docs/fsf-logo_1.png" /></a></p>
<p><a class="reference external" href="https://my.fsf.org/donate/"><img alt="Donate" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" /></a></p>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

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

Binary file added docs/fsf-logo_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 21 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,15 @@ Dependencies
-------------

**check_mysqldb** requires next modules and libraries:
sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

* sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

Shell tool structure
---------------------

**check_mysqldb** is based on MOP.

Shell tool structure:
Code structure:

.. code-block:: bash
Expand Down Expand Up @@ -95,3 +96,21 @@ Copyright (C) 2016 by `vroncevic.github.io/check_mysqldb <https://vroncevic.gith
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.

Lets help and support FSF.

|Free Software Foundation|

.. |Free Software Foundation| image:: https://raw.githubusercontent.com/vroncevic/check_mysqldb/dev/docs/fsf-logo_1.png
:target: https://my.fsf.org/

|Donate|

.. |Donate| image:: https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif
:target: https://my.fsf.org/donate/

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 509b6cf

Please sign in to comment.