Update more references

thevickypedia · Aug 10, 2023 · 4bebb8c · 4bebb8c
1 parent 389f381
commit 4bebb8c
Show file tree

Hide file tree

Showing 13 changed files with 317 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 ![Python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
 
 [![pages-build-deployment](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment)
-[![pypi](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)
+[![pypi-publish](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)
 
 [![Pypi-format](https://img.shields.io/pypi/format/gitverse)](https://pypi.org/project/gitverse/#files)
 [![Pypi-status](https://img.shields.io/pypi/status/gitverse)](https://pypi.org/project/gitverse)
@@ -12,33 +12,34 @@
 [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)
 [![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)
 
-# CHANGELOG generator
-Generate CHANGELOG from git commit history
+# GitVerse
 
 ### Installation
 ```shell
 pip install gitverse
 ```
 
 ### Usage
-#### Commit History
+#### Release Notes (Tags)
+Generate release notes from releases tagged in GitHub
 ```shell
-gitverse-commit
+gitverse-release
 ```
 
-#### Release Notes (Tags)
+Generate commit history from git log
+#### Commit History
 ```shell
-gitverse-release
+gitverse-commit
 ```
 
 ##### Options
 - `debug` - Enable debug mode for logging.
 - `reverse` - Generate commit history/release notes in reverse order.
 
 ##### Flags
-- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed
-- `-f` Write the commit notes to a custom filename. Defaults to `CHANGELOG`
-- `-t` Title or index line for the file generated. Defaults to `Change Log`
+- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed. (Only for `gitverse-commit`)
+- `-f` Write the commit notes to a custom filename.
+- `-t` Title or index line for the file generated.
 
 #### Sample
 [release_notes.rst][release_notes]

diff --git a/changelog.rst b/changelog.rst
@@ -1,6 +1,10 @@
 Commit History
 ==============
 
+0.3.6 (08/09/2023)
+------------------
+- Update more references
+
 0.3.5 (08/09/2023)
 ------------------
 - Add an option to generate release notes

diff --git a/doc_generator/index.rst b/doc_generator/index.rst
@@ -1,9 +1,9 @@
-.. Changelog Generator documentation master file, created by
+.. GitVerse documentation master file, created by
    sphinx-quickstart on Mon Aug 30 22:50:58 2021.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Changelog Generator's documentation!
+Welcome to GitVerse's documentation!
 ===============================================
 
 .. toctree::
@@ -12,10 +12,17 @@ Welcome to Changelog Generator's documentation!
 
    README
 
-CHANGELOG Generator
-===================
+ReleaseNotes
+============
 
-.. automodule:: generator
+.. automodule:: releases
+   :members:
+   :undoc-members:
+
+CommitHistory
+=============
+
+.. automodule:: commits
    :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>CHANGELOG generator &#8212; Changelog Generator  documentation</title>
+    <title>GitVerse &#8212; Changelog Generator  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -18,7 +18,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Welcome to Changelog Generator’s documentation!" href="index.html" /> 
+    <link rel="prev" title="Welcome to GitVerse’s documentation!" href="index.html" /> 
   </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
@@ -30,10 +30,10 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="index.html" title="Welcome to Changelog Generator’s documentation!"
+          <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-this"><a href="">CHANGELOG generator</a></li> 
+        <li class="nav-item nav-item-this"><a href="">GitVerse</a></li> 
       </ul>
     </div>  
 
@@ -45,16 +45,15 @@ <h3>Navigation</h3>
   <p><a class="reference external" href="https://pypi.org/project/gitverse"><img alt="Pypi-version" src="https://img.shields.io/pypi/v/gitverse" /></a>
 <img alt="Python" src="https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue" /></p>
 <p><a class="reference external" href="https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment"><img alt="pages-build-deployment" src="https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
-<a class="reference external" href="https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg" /></a></p>
+<a class="reference external" href="https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml"><img alt="pypi-publish" src="https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg" /></a></p>
 <p><a class="reference external" href="https://pypi.org/project/gitverse/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/gitverse" /></a>
 <a class="reference external" href="https://pypi.org/project/gitverse"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/gitverse" /></a></p>
 <p><img alt="Maintained" src="https://img.shields.io/maintenance/yes/2023" />
 <a class="reference external" href="https://api.github.com/repos/thevickypedia/gitverse"><img alt="GitHub Repo created" src="https://img.shields.io/date/1630367571" /></a>
 <a class="reference external" href="https://api.github.com/repos/thevickypedia/gitverse"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/y/thevickypedia/gitverse" /></a>
 <a class="reference external" href="https://api.github.com/repos/thevickypedia/gitverse"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/thevickypedia/gitverse" /></a></p>
-<section id="changelog-generator">
-<h1>CHANGELOG generator<a class="headerlink" href="#changelog-generator" title="Permalink to this heading">¶</a></h1>
-<p>Generate CHANGELOG from git commit history</p>
+<section id="gitverse">
+<h1>GitVerse<a class="headerlink" href="#gitverse" title="Permalink to this heading">¶</a></h1>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
@@ -63,17 +62,19 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </section>
 <section id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">¶</a></h2>
-<section id="commit-history">
-<h3>Commit History<a class="headerlink" href="#commit-history" title="Permalink to this heading">¶</a></h3>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-commit
-</pre></div>
-</div>
-</section>
 <section id="release-notes-tags">
 <h3>Release Notes (Tags)<a class="headerlink" href="#release-notes-tags" title="Permalink to this heading">¶</a></h3>
+<p>Generate release notes from releases tagged in GitHub</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-release
 </pre></div>
 </div>
+<p>Generate commit history from git log</p>
+</section>
+<section id="commit-history">
+<h3>Commit History<a class="headerlink" href="#commit-history" title="Permalink to this heading">¶</a></h3>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-commit
+</pre></div>
+</div>
 <section id="options">
 <h4>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h4>
 <ul class="simple">
@@ -84,9 +85,9 @@ <h4>Options<a class="headerlink" href="#options" title="Permalink to this headin
 <section id="flags">
 <h4>Flags<a class="headerlink" href="#flags" title="Permalink to this heading">¶</a></h4>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">-b</span></code> Gather commit notes specific to a branch. Uses <code class="docutils literal notranslate"><span class="pre">Default</span> <span class="pre">branch</span></code> if not passed</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">-f</span></code> Write the commit notes to a custom filename. Defaults to <code class="docutils literal notranslate"><span class="pre">CHANGELOG</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">-t</span></code> Title or index line for the file generated. Defaults to <code class="docutils literal notranslate"><span class="pre">Change</span> <span class="pre">Log</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-b</span></code> Gather commit notes specific to a branch. Uses <code class="docutils literal notranslate"><span class="pre">Default</span> <span class="pre">branch</span></code> if not passed. (Only for <code class="docutils literal notranslate"><span class="pre">gitverse-commit</span></code>)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-f</span></code> Write the commit notes to a custom filename.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-t</span></code> Title or index line for the file generated.</p></li>
 </ul>
 </section>
 </section>
@@ -135,11 +136,11 @@ <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
     <ul>
-<li><a class="reference internal" href="#">CHANGELOG generator</a><ul>
+<li><a class="reference internal" href="#">GitVerse</a><ul>
 <li><a class="reference internal" href="#installation">Installation</a></li>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
-<li><a class="reference internal" href="#commit-history">Commit History</a></li>
-<li><a class="reference internal" href="#release-notes-tags">Release Notes (Tags)</a><ul>
+<li><a class="reference internal" href="#release-notes-tags">Release Notes (Tags)</a></li>
+<li><a class="reference internal" href="#commit-history">Commit History</a><ul>
 <li><a class="reference internal" href="#options">Options</a></li>
 <li><a class="reference internal" href="#flags">Flags</a></li>
 </ul>
@@ -161,7 +162,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
   <div>
     <h4>Previous topic</h4>
     <p class="topless"><a href="index.html"
-                          title="previous chapter">Welcome to Changelog Generator’s documentation!</a></p>
+                          title="previous chapter">Welcome to GitVerse’s documentation!</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -194,10 +195,10 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="index.html" title="Welcome to Changelog Generator’s documentation!"
+          <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-this"><a href="">CHANGELOG generator</a></li> 
+        <li class="nav-item nav-item-this"><a href="">GitVerse</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -2,7 +2,7 @@
 ![Python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
 
 [![pages-build-deployment](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment)
-[![pypi](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)
+[![pypi-publish](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)
 
 [![Pypi-format](https://img.shields.io/pypi/format/gitverse)](https://pypi.org/project/gitverse/#files)
 [![Pypi-status](https://img.shields.io/pypi/status/gitverse)](https://pypi.org/project/gitverse)
@@ -12,33 +12,34 @@
 [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)
 [![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)
 
-# CHANGELOG generator
-Generate CHANGELOG from git commit history
+# GitVerse
 
 ### Installation
 ```shell
 pip install gitverse
 ```
 
 ### Usage
-#### Commit History
+#### Release Notes (Tags)
+Generate release notes from releases tagged in GitHub
 ```shell
-gitverse-commit
+gitverse-release
 ```
 
-#### Release Notes (Tags)
+Generate commit history from git log
+#### Commit History
 ```shell
-gitverse-release
+gitverse-commit
 ```
 
 ##### Options
 - `debug` - Enable debug mode for logging.
 - `reverse` - Generate commit history/release notes in reverse order.
 
 ##### Flags
-- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed
-- `-f` Write the commit notes to a custom filename. Defaults to `CHANGELOG`
-- `-t` Title or index line for the file generated. Defaults to `Change Log`
+- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed. (Only for `gitverse-commit`)
+- `-f` Write the commit notes to a custom filename.
+- `-t` Title or index line for the file generated.
 
 #### Sample
 [release_notes.rst][release_notes]

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -1,9 +1,9 @@
-.. Changelog Generator documentation master file, created by
+.. GitVerse documentation master file, created by
    sphinx-quickstart on Mon Aug 30 22:50:58 2021.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Changelog Generator's documentation!
+Welcome to GitVerse's documentation!
 ===============================================
 
 .. toctree::
@@ -12,10 +12,17 @@ Welcome to Changelog Generator's documentation!
 
    README
 
-CHANGELOG Generator
-===================
+ReleaseNotes
+============
 
-.. automodule:: generator
+.. automodule:: releases
+   :members:
+   :undoc-members:
+
+CommitHistory
+=============
+
+.. automodule:: commits
    :members:
    :undoc-members: