Reuse options via callables.py

Reduce the usage of conditional debug Add more debug statements Update docs and bump version
thevickypedia · Aug 10, 2023 · eac1699 · eac1699
1 parent b399752
commit eac1699
Show file tree

Hide file tree

Showing 17 changed files with 209 additions and 224 deletions.
diff --git a/changelog.rst b/changelog.rst
@@ -1,6 +1,13 @@
 Commit History
 ==============
 
+0.4.1 (08/10/2023)
+------------------
+- Reuse options via callables.py
+- Reduce the usage of conditional debug
+- Add more debug statements
+- Update docs and bump version
+
 0.4.0 (08/10/2023)
 ------------------
 - Release v2.0

diff --git a/doc_generator/conf.py b/doc_generator/conf.py
@@ -13,12 +13,12 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..' + os.path.sep + 'gitverse'))
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Changelog Generator'
+project = 'GitVerse'
 copyright = '2021, Vignesh Sivanandha Rao'
 author = 'Vignesh Sivanandha Rao'
 

diff --git a/doc_generator/index.rst b/doc_generator/index.rst
@@ -15,28 +15,28 @@ Welcome to GitVerse's documentation!
 ReleaseNotes
 ============
 
-.. automodule:: releases
+.. automodule:: gitverse.releases
    :members:
    :undoc-members:
 
 CommitHistory
 =============
 
-.. automodule:: commits
+.. automodule:: gitverse.commits
    :members:
    :undoc-members:
 
 Debugger
 ========
 
-.. automodule:: debugger
+.. automodule:: gitverse.debugger
    :members:
    :undoc-members:
 
 RST Parser
 ==========
 
-.. automodule:: utils.rst
+.. automodule:: gitverse.utils.rst
    :members:
    :undoc-members:
 

diff --git a/docs/README.html b/docs/README.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>GitVerse &#8212; Changelog Generator  documentation</title>
+    <title>GitVerse &#8212; GitVerse  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Welcome to GitVerse’s documentation!"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Changelog Generator  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">GitVerse  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GitVerse</a></li> 
       </ul>
     </div>  
@@ -203,7 +203,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Welcome to GitVerse’s documentation!"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Changelog Generator  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">GitVerse  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GitVerse</a></li> 
       </ul>
     </div>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -15,28 +15,28 @@ Welcome to GitVerse's documentation!
 ReleaseNotes
 ============
 
-.. automodule:: releases
+.. automodule:: gitverse.releases
    :members:
    :undoc-members:
 
 CommitHistory
 =============
 
-.. automodule:: commits
+.. automodule:: gitverse.commits
    :members:
    :undoc-members:
 
 Debugger
 ========
 
-.. automodule:: debugger
+.. automodule:: gitverse.debugger
    :members:
    :undoc-members:
 
 RST Parser
 ==========
 
-.. automodule:: utils.rst
+.. automodule:: gitverse.utils.rst
    :members:
    :undoc-members:
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Changelog Generator  documentation</title>
+    <title>Index &#8212; GitVerse  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Changelog Generator  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">GitVerse  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -41,85 +41,89 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
- | <a href="#D"><strong>D</strong></a>
+ <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#R"><strong>R</strong></a>
- | <a href="#U"><strong>U</strong></a>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
-<h2 id="C">C</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    commits
-
-      <ul>
-        <li><a href="index.html#module-commits">module</a>
-</li>
-      </ul></li>
-  </ul></td>
-</tr></table>
-
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#debugger.debug">debug() (in module debugger)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    debugger
-
-      <ul>
-        <li><a href="index.html#module-debugger">module</a>
+      <li><a href="index.html#gitverse.debugger.debug">debug() (in module gitverse.debugger)</a>
 </li>
-      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#debugger.error">error() (in module debugger)</a>
+      <li><a href="index.html#gitverse.debugger.error">error() (in module gitverse.debugger)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#releases.generate_snippets">generate_snippets() (in module releases)</a>
+      <li><a href="index.html#gitverse.releases.generate_snippets">generate_snippets() (in module gitverse.releases)</a>
+</li>
+      <li><a href="index.html#gitverse.commits.generator">generator() (in module gitverse.commits)</a>
+</li>
+      <li><a href="index.html#gitverse.releases.get_api_releases">get_api_releases() (in module gitverse.releases)</a>
+</li>
+      <li><a href="index.html#gitverse.commits.get_branches">get_branches() (in module gitverse.commits)</a>
 </li>
-      <li><a href="index.html#commits.generator">generator() (in module commits)</a>
+      <li><a href="index.html#gitverse.commits.get_commits">get_commits() (in module gitverse.commits)</a>
 </li>
-      <li><a href="index.html#releases.get_api_releases">get_api_releases() (in module releases)</a>
+      <li><a href="index.html#gitverse.releases.get_dates">get_dates() (in module gitverse.releases)</a>
 </li>
-      <li><a href="index.html#commits.get_branches">get_branches() (in module commits)</a>
+      <li><a href="index.html#gitverse.commits.get_gitlog">get_gitlog() (in module gitverse.commits)</a>
+</li>
+      <li><a href="index.html#gitverse.utils.rst.get_release_notes">get_release_notes() (in module gitverse.utils.rst)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#commits.get_commits">get_commits() (in module commits)</a>
+      <li><a href="index.html#gitverse.releases.get_releases">get_releases() (in module gitverse.releases)</a>
 </li>
-      <li><a href="index.html#releases.get_dates">get_dates() (in module releases)</a>
+      <li>
+    gitverse.commits
+
+      <ul>
+        <li><a href="index.html#module-gitverse.commits">module</a>
 </li>
-      <li><a href="index.html#commits.get_gitlog">get_gitlog() (in module commits)</a>
+      </ul></li>
+      <li>
+    gitverse.debugger
+
+      <ul>
+        <li><a href="index.html#module-gitverse.debugger">module</a>
 </li>
-      <li><a href="index.html#utils.rst.get_release_notes">get_release_notes() (in module utils.rst)</a>
+      </ul></li>
+      <li>
+    gitverse.releases
+
+      <ul>
+        <li><a href="index.html#module-gitverse.releases">module</a>
 </li>
-      <li><a href="index.html#releases.get_releases">get_releases() (in module releases)</a>
+      </ul></li>
+      <li>
+    gitverse.utils.rst
+
+      <ul>
+        <li><a href="index.html#module-gitverse.utils.rst">module</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#debugger.info">info() (in module debugger)</a>
+      <li><a href="index.html#gitverse.debugger.info">info() (in module gitverse.debugger)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -131,13 +135,13 @@ <h2 id="M">M</h2>
     module
 
       <ul>
-        <li><a href="index.html#module-commits">commits</a>
+        <li><a href="index.html#module-gitverse.commits">gitverse.commits</a>
 </li>
-        <li><a href="index.html#module-debugger">debugger</a>
+        <li><a href="index.html#module-gitverse.debugger">gitverse.debugger</a>
 </li>
-        <li><a href="index.html#module-releases">releases</a>
+        <li><a href="index.html#module-gitverse.releases">gitverse.releases</a>
 </li>
-        <li><a href="index.html#module-utils.rst">utils.rst</a>
+        <li><a href="index.html#module-gitverse.utils.rst">gitverse.utils.rst</a>
 </li>
       </ul></li>
   </ul></td>
@@ -146,47 +150,27 @@ <h2 id="M">M</h2>
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    releases
-
-      <ul>
-        <li><a href="index.html#module-releases">module</a>
+      <li><a href="index.html#gitverse.utils.rst.rst2dict">rst2dict() (in module gitverse.utils.rst)</a>
 </li>
-      </ul></li>
-      <li><a href="index.html#utils.rst.rst2dict">rst2dict() (in module utils.rst)</a>
+      <li><a href="index.html#gitverse.utils.rst.rst2html">rst2html() (in module gitverse.utils.rst)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#utils.rst.rst2html">rst2html() (in module utils.rst)</a>
-</li>
-      <li><a href="index.html#commits.run">run() (in module commits)</a>
+      <li><a href="index.html#gitverse.commits.run">run() (in module gitverse.commits)</a>
 
       <ul>
-        <li><a href="index.html#releases.run">(in module releases)</a>
+        <li><a href="index.html#gitverse.releases.run">(in module gitverse.releases)</a>
 </li>
       </ul></li>
-      <li><a href="index.html#releases.run_git_cmd">run_git_cmd() (in module releases)</a>
+      <li><a href="index.html#gitverse.releases.run_git_cmd">run_git_cmd() (in module gitverse.releases)</a>
 </li>
   </ul></td>
 </tr></table>
 
-<h2 id="U">U</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    utils.rst
-
-      <ul>
-        <li><a href="index.html#module-utils.rst">module</a>
-</li>
-      </ul></li>
-  </ul></td>
-</tr></table>
-
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#debugger.warning">warning() (in module debugger)</a>
+      <li><a href="index.html#gitverse.debugger.warning">warning() (in module gitverse.debugger)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -222,7 +206,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Changelog Generator  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">GitVerse  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>