docs: fix badge and some docstring

CHANGELOG.md

@@ -4,8 +4,8 @@ All notable changes to this project will be documented in this file.
 See [standard-version](https://github.com/conventional-changelog/standard-version)
 and `README.md` file for commit guidelines. Also you should check [conventional-changelog](https://github.com/mdsanima/conventional-changelog) for more detail.
 
-Docomentation for **mdsanima_dev** Python Package is available
-at [docs mdsanima_dev](https://mdsanima-dev.github.io/mdsanima-dev/) be sure to check it.
+Docomentation for **mdsanima-dev** Python Package is available
+at [docs mdsanima-dev](https://mdsanima-dev.github.io/mdsanima-dev/) be sure to check it.
 
 ## 0.1.0
 
@@ -54,16 +54,20 @@ at [docs mdsanima_dev](https://mdsanima-dev.github.io/mdsanima-dev/) be sure to
 
 ### Documentation
 
-* fix duplicate label ([2c2ed8a](https://github.com/mdsanima-dev/mdsanima-dev/commit/2c2ed8aaeb91177452391adf5c36e7ef3ea2fbc2))
+* **gh-pages:** build setup fixed ([29a63e0](https://github.com/mdsanima-dev/mdsanima-dev/commit/29a63e088e48d0f5b492c0c5c846a4969eb8ae4f))
+* fix package name on `pypi` install ([bde85ef](https://github.com/mdsanima-dev/mdsanima-dev/commit/bde85ef73eb821f24ddf0b3d37551719b97b73f8))
 * **devs:** development instruction workflow ([7dfec4c](https://github.com/mdsanima-dev/mdsanima-dev/commit/7dfec4c72584f4d907df500cbc70a8514733199c))
+* **gh-pages:** fix redirecting `url` ([7643624](https://github.com/mdsanima-dev/mdsanima-dev/commit/7643624cfcab90e63981b3795813b87217bd661a))
+* fix duplicate label ([2c2ed8a](https://github.com/mdsanima-dev/mdsanima-dev/commit/2c2ed8aaeb91177452391adf5c36e7ef3ea2fbc2))
+* **fix:** repository clone url ([bee45c7](https://github.com/mdsanima-dev/mdsanima-dev/commit/bee45c726c14a68eb4b09e745e28836980c98314))
 * **gh-pages:** create empty `.nojekyll` closes [#12](https://github.com/mdsanima-dev/mdsanima-dev/issues/12) ([5bb21b2](https://github.com/mdsanima-dev/mdsanima-dev/commit/5bb21b201c89951d794d88b2f4eb865f8b815ee0))
+* **gif:** add gif animation closes [#10](https://github.com/mdsanima-dev/mdsanima-dev/issues/10) ([de8e9ca](https://github.com/mdsanima-dev/mdsanima-dev/commit/de8e9caa4fce235f21d2f3a2c58b13bcd94155a1)), closes [#2](https://github.com/mdsanima-dev/mdsanima-dev/issues/2)
+* add `toctree` changelog for `sphinx` documentation ([4aae253](https://github.com/mdsanima-dev/mdsanima-dev/commit/4aae2533f6edcae573baea5bb5cf82a24407cdf3))
+* add badge to `README.md` file ([6ee2d6b](https://github.com/mdsanima-dev/mdsanima-dev/commit/6ee2d6b4a85852db6b3bd72c9dc921840dc54853))
 * **gh-pages:** meta `url` refers `index.html` closes [#11](https://github.com/mdsanima-dev/mdsanima-dev/issues/11) ([c4ceac7](https://github.com/mdsanima-dev/mdsanima-dev/commit/c4ceac7fdd3f5eeb64a42389d773f3ae3110149e))
 * **gh-pages:** meta contents refers to `build` shpinx closes [#13](https://github.com/mdsanima-dev/mdsanima-dev/issues/13) ([5545f4a](https://github.com/mdsanima-dev/mdsanima-dev/commit/5545f4a5618b4ab955679ffb13743ed70594bf0d))
-* **gif:** add gif animation closes [#10](https://github.com/mdsanima-dev/mdsanima-dev/issues/10) ([de8e9ca](https://github.com/mdsanima-dev/mdsanima-dev/commit/de8e9caa4fce235f21d2f3a2c58b13bcd94155a1)), closes [#2](https://github.com/mdsanima-dev/mdsanima-dev/issues/2)
 * add `extension` and `markdown` parser closes [#3](https://github.com/mdsanima-dev/mdsanima-dev/issues/3) ([38b3552](https://github.com/mdsanima-dev/mdsanima-dev/commit/38b3552116817fce65fc1e6b45587e43a9e5faea))
 * add `README.md` information ([2efd757](https://github.com/mdsanima-dev/mdsanima-dev/commit/2efd7574848e5f09b013f2efc98427a21b72d42d))
-* add `toctree` changelog for `sphinx` documentation ([4aae253](https://github.com/mdsanima-dev/mdsanima-dev/commit/4aae2533f6edcae573baea5bb5cf82a24407cdf3))
-* add badge to `README.md` file ([6ee2d6b](https://github.com/mdsanima-dev/mdsanima-dev/commit/6ee2d6b4a85852db6b3bd72c9dc921840dc54853))
 * add documentation string ([7faf2b0](https://github.com/mdsanima-dev/mdsanima-dev/commit/7faf2b0213e8971fb073a6daac9f490cd0740f27))
 * add theme and html option closes [#4](https://github.com/mdsanima-dev/mdsanima-dev/issues/4) ([765ed8e](https://github.com/mdsanima-dev/mdsanima-dev/commit/765ed8e6b8c57e1118428737c6f78cc0ac60089b))
 * deteting old files `.rst` and make ([778eee6](https://github.com/mdsanima-dev/mdsanima-dev/commit/778eee6a88c60f21a11a79127e4efdc0e958f6f5))
@@ -76,7 +80,6 @@ at [docs mdsanima_dev](https://mdsanima-dev.github.io/mdsanima-dev/) be sure to
 * **colors:** documentation colors string ([d325764](https://github.com/mdsanima-dev/mdsanima-dev/commit/d32576405c5d87234f60be3ad749444996b0b23f))
 * **emoji:** add documentation string to a function ([86c6037](https://github.com/mdsanima-dev/mdsanima-dev/commit/86c6037ca6db19b7b7ba5621c23f29befdd5fea6))
 * **emoji:** documentation emoji string ([4853b78](https://github.com/mdsanima-dev/mdsanima-dev/commit/4853b788e5710d1ce965229f60342be0fb0dc00a))
-* **fix:** repository clone url ([bee45c7](https://github.com/mdsanima-dev/mdsanima-dev/commit/bee45c726c14a68eb4b09e745e28836980c98314))
 * **gif:** add gif animation showcase ([b5c26e0](https://github.com/mdsanima-dev/mdsanima-dev/commit/b5c26e09250f977712488e8a7d88ef05f508fa39))
 * **icons:** add `mdsanima` icons logos variation ([7ac931a](https://github.com/mdsanima-dev/mdsanima-dev/commit/7ac931a6ac81f3b4bde45e4d9dfefc1056048bb0))
 * **screenshot:** add console screenshot img ([762bdc8](https://github.com/mdsanima-dev/mdsanima-dev/commit/762bdc838b6776970fad0ebc028e4ece8c841990))

README.md

@@ -3,7 +3,7 @@
 ![GitHub issues](https://img.shields.io/github/issues-raw/mdsanima-dev/mdsanima-dev?style=flat)
 ![GitHub closed issues](https://img.shields.io/github/issues-closed/mdsanima-dev/mdsanima-dev?style=flat)
 ![GitHub](https://img.shields.io/github/license/mdsanima-dev/mdsanima-dev?style=flat)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mdsanima_dev?style=flat)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mdsanima-dev?style=flat)
 ![Lines of code](https://img.shields.io/tokei/lines/github/mdsanima-dev/mdsanima-dev?style=flat)
 ![GitHub top language](https://img.shields.io/github/languages/top/mdsanima-dev/mdsanima-dev)
 
@@ -14,7 +14,7 @@ modules. So let me show something.
 
 This Python Pacage developed by Marcin Różewski aka
 [MDSANIM](https://mdsanima.com) includes several useful modules thats he uses
-in various projects. Docomentation for **mdsanima_dev** Python Package
+in various projects. Docomentation for **mdsanima-dev** Python Package
 is available at [docs mdsanima-dev](https://mdsanima-dev.github.io/mdsanima-dev/)
 be sure to check it.
 

docs/html/_sources/development.md.txt

@@ -61,7 +61,9 @@ create an installable Python Package from your `code` and send it to `PyPi`.
 Build Setpu:
 
 ```shell
-python3 setup.py sdist bdist_wheel
+python3 setup.py install
+python3.7 setup.py install
+python3.8 setup.py install
 ```
 
 It created some new directories for us, such as `dist`, `build`

docs/html/changelog.html

@@ -275,8 +275,8 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <p>All notable changes to this project will be documented in this file.
 See <a class="reference external" href="https://github.com/conventional-changelog/standard-version">standard-version</a>
 and <code class="docutils literal notranslate"><span class="pre">README.md</span></code> file for commit guidelines. Also you should check <a class="reference external" href="https://github.com/mdsanima/conventional-changelog">conventional-changelog</a> for more detail.</p>
-<p>Docomentation for <strong>mdsanima_dev</strong> Python Package is available
-at <a class="reference external" href="https://mdsanima-dev.github.io/mdsanima-dev/">docs mdsanima_dev</a> be sure to check it.</p>
+<p>Docomentation for <strong>mdsanima-dev</strong> Python Package is available
+at <a class="reference external" href="https://mdsanima-dev.github.io/mdsanima-dev/">docs mdsanima-dev</a> be sure to check it.</p>
 <div class="section" id="id1">
 <h2>0.1.0<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <p><em>Date:</em> <em>2021-08-13</em></p>
@@ -330,16 +330,20 @@ <h3>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">
 <div class="section" id="documentation">
 <h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>fix duplicate label (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/2c2ed8aaeb91177452391adf5c36e7ef3ea2fbc2">2c2ed8a</a>)</p></li>
+<li><p><strong>gh-pages:</strong> build setup fixed (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/29a63e088e48d0f5b492c0c5c846a4969eb8ae4f">29a63e0</a>)</p></li>
+<li><p>fix package name on <code class="docutils literal notranslate"><span class="pre">pypi</span></code> install (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/bde85ef73eb821f24ddf0b3d37551719b97b73f8">bde85ef</a>)</p></li>
 <li><p><strong>devs:</strong> development instruction workflow (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/7dfec4c72584f4d907df500cbc70a8514733199c">7dfec4c</a>)</p></li>
+<li><p><strong>gh-pages:</strong> fix redirecting <code class="docutils literal notranslate"><span class="pre">url</span></code> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/7643624cfcab90e63981b3795813b87217bd661a">7643624</a>)</p></li>
+<li><p>fix duplicate label (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/2c2ed8aaeb91177452391adf5c36e7ef3ea2fbc2">2c2ed8a</a>)</p></li>
+<li><p><strong>fix:</strong> repository clone url (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/bee45c726c14a68eb4b09e745e28836980c98314">bee45c7</a>)</p></li>
 <li><p><strong>gh-pages:</strong> create empty <code class="docutils literal notranslate"><span class="pre">.nojekyll</span></code> closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/12">#12</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/5bb21b201c89951d794d88b2f4eb865f8b815ee0">5bb21b2</a>)</p></li>
+<li><p><strong>gif:</strong> add gif animation closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/10">#10</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/de8e9caa4fce235f21d2f3a2c58b13bcd94155a1">de8e9ca</a>), closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/2">#2</a></p></li>
+<li><p>add <code class="docutils literal notranslate"><span class="pre">toctree</span></code> changelog for <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> documentation (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/4aae2533f6edcae573baea5bb5cf82a24407cdf3">4aae253</a>)</p></li>
+<li><p>add badge to <code class="docutils literal notranslate"><span class="pre">README.md</span></code> file (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/6ee2d6b4a85852db6b3bd72c9dc921840dc54853">6ee2d6b</a>)</p></li>
 <li><p><strong>gh-pages:</strong> meta <code class="docutils literal notranslate"><span class="pre">url</span></code> refers <code class="docutils literal notranslate"><span class="pre">index.html</span></code> closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/11">#11</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/c4ceac7fdd3f5eeb64a42389d773f3ae3110149e">c4ceac7</a>)</p></li>
 <li><p><strong>gh-pages:</strong> meta contents refers to <code class="docutils literal notranslate"><span class="pre">build</span></code> shpinx closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/13">#13</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/5545f4a5618b4ab955679ffb13743ed70594bf0d">5545f4a</a>)</p></li>
-<li><p><strong>gif:</strong> add gif animation closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/10">#10</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/de8e9caa4fce235f21d2f3a2c58b13bcd94155a1">de8e9ca</a>), closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/2">#2</a></p></li>
 <li><p>add <code class="docutils literal notranslate"><span class="pre">extension</span></code> and <code class="docutils literal notranslate"><span class="pre">markdown</span></code> parser closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/3">#3</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/38b3552116817fce65fc1e6b45587e43a9e5faea">38b3552</a>)</p></li>
 <li><p>add <code class="docutils literal notranslate"><span class="pre">README.md</span></code> information (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/2efd7574848e5f09b013f2efc98427a21b72d42d">2efd757</a>)</p></li>
-<li><p>add <code class="docutils literal notranslate"><span class="pre">toctree</span></code> changelog for <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> documentation (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/4aae2533f6edcae573baea5bb5cf82a24407cdf3">4aae253</a>)</p></li>
-<li><p>add badge to <code class="docutils literal notranslate"><span class="pre">README.md</span></code> file (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/6ee2d6b4a85852db6b3bd72c9dc921840dc54853">6ee2d6b</a>)</p></li>
 <li><p>add documentation string (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/7faf2b0213e8971fb073a6daac9f490cd0740f27">7faf2b0</a>)</p></li>
 <li><p>add theme and html option closes <a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/issues/4">#4</a> (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/765ed8e6b8c57e1118428737c6f78cc0ac60089b">765ed8e</a>)</p></li>
 <li><p>deteting old files <code class="docutils literal notranslate"><span class="pre">.rst</span></code> and make (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/778eee6a88c60f21a11a79127e4efdc0e958f6f5">778eee6</a>)</p></li>
@@ -352,7 +356,6 @@ <h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 <li><p><strong>colors:</strong> documentation colors string (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/d32576405c5d87234f60be3ad749444996b0b23f">d325764</a>)</p></li>
 <li><p><strong>emoji:</strong> add documentation string to a function (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/86c6037ca6db19b7b7ba5621c23f29befdd5fea6">86c6037</a>)</p></li>
 <li><p><strong>emoji:</strong> documentation emoji string (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/4853b788e5710d1ce965229f60342be0fb0dc00a">4853b78</a>)</p></li>
-<li><p><strong>fix:</strong> repository clone url (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/bee45c726c14a68eb4b09e745e28836980c98314">bee45c7</a>)</p></li>
 <li><p><strong>gif:</strong> add gif animation showcase (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/b5c26e09250f977712488e8a7d88ef05f508fa39">b5c26e0</a>)</p></li>
 <li><p><strong>icons:</strong> add <code class="docutils literal notranslate"><span class="pre">mdsanima</span></code> icons logos variation (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/7ac931a6ac81f3b4bde45e4d9dfefc1056048bb0">7ac931a</a>)</p></li>
 <li><p><strong>screenshot:</strong> add console screenshot img (<a class="reference external" href="https://github.com/mdsanima-dev/mdsanima-dev/commit/762bdc838b6776970fad0ebc028e4ece8c841990">762bdc8</a>)</p></li>

docs/html/development.html

@@ -325,7 +325,9 @@ <h2>Build Pacage<a class="headerlink" href="#build-pacage" title="Permalink to t
 <p>We’re almost done. We just need to put commands in to terminal and which will
 create an installable Python Package from your <code class="docutils literal notranslate"><span class="pre">code</span></code> and send it to <code class="docutils literal notranslate"><span class="pre">PyPi</span></code>.</p>
 <p>Build Setpu:</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 setup.py sdist bdist_wheel
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 setup.py install
+python3.7 setup.py install
+python3.8 setup.py install
 </pre></div>
 </div>
 <p>It created some new directories for us, such as <code class="docutils literal notranslate"><span class="pre">dist</span></code>, <code class="docutils literal notranslate"><span class="pre">build</span></code>

docs/html/index.html

@@ -345,7 +345,7 @@ <h2>Python Package <code class="docutils literal notranslate"><span class="pre">
 <p>This Python Pacage developed by Marcin Różewski aka
 <a class="reference external" href="https://mdsanima.com">MDSANIM</a> includes several useful modules thats he uses
 in various projects. Docomentation for <strong>mdsanima_dev</strong> Python Package
-is available at <a class="reference external" href="https://mdsanima-dev.github.io/mdsanima-dev/">docs mdsanima_dev</a>
+is available at <a class="reference external" href="https://mdsanima-dev.github.io/mdsanima-dev/">docs mdsanima-dev</a>
 be sure to check it.</p>
 </div>
 <div class="section" id="installation">
@@ -354,20 +354,20 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <div class="section" id="using-pypi">
 <h3>Using PyPi<a class="headerlink" href="#using-pypi" title="Permalink to this headline">¶</a></h3>
 <p>Install latest version:</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install mdsanima_dev
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install mdsanima-dev
 </pre></div>
 </div>
 <p>Install specific version:</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install <span class="nv">mdsanima_dev</span><span class="o">==</span><span class="m">0</span>.1.0
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install mdsanima-dev<span class="o">==</span><span class="m">0</span>.1.0
 </pre></div>
 </div>
 <p>Upgrade pacage to latest version:</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install --upgrade mdsanima_dev
-python3 -m pip install --force-reinstall msdsanima_dev
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip install --upgrade mdsanima-dev
+python3 -m pip install --force-reinstall msdsanima-dev
 </pre></div>
 </div>
 <p>Uninstall pacage:</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip uninstall mdsanima_dev
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 -m pip uninstall mdsanima-dev
 </pre></div>
 </div>
 </div>