From 78db3c2be4989cb01ac78e4d8faaf6fe54da3610 Mon Sep 17 00:00:00 2001
From: Gwyn Uttmark <biosafetylevel5@gmail.com>
Date: Tue, 5 Nov 2024 19:35:31 +0000
Subject: [PATCH] Update dependencies and build new docs

---
 docs/.buildinfo                               |   4 +-
 .../brassy/actions/build_release_notes.html   |   6 +-
 docs/_modules/brassy/actions/init.html        |   6 +-
 docs/_modules/brassy/actions/prune_yaml.html  |   6 +-
 docs/_modules/brassy/brassy.html              |   6 +-
 .../templates/release_yaml_template.html      |  14 ++--
 .../brassy/templates/settings_template.html   |   6 +-
 docs/_modules/brassy/utils/CLI.html           |   6 +-
 docs/_modules/brassy/utils/file_handler.html  |   6 +-
 docs/_modules/brassy/utils/git_handler.html   |  33 ++++++---
 docs/_modules/brassy/utils/messages.html      |   6 +-
 .../brassy/utils/settings_manager.html        |   6 +-
 docs/_modules/index.html                      |   6 +-
 docs/_sources/using-brassy.rst.txt            |  50 ++++++++++++++
 docs/_static/basic.css                        |  15 +---
 docs/_static/doctools.js                      |   7 --
 docs/_static/language_data.js                 |   7 --
 docs/_static/searchtools.js                   |  38 ++++++----
 docs/api.html                                 |  65 +++++++++++++-----
 docs/genindex.html                            |  10 +--
 docs/index.html                               |   7 +-
 docs/objects.inv                              | Bin 1452 -> 1454 bytes
 docs/py-modindex.html                         |   6 +-
 docs/releases/0.0.2.html                      |   6 +-
 docs/releases/0.0.3.html                      |   6 +-
 docs/releases/index.html                      |   6 +-
 docs/search.html                              |   6 +-
 docs/searchindex.js                           |   2 +-
 docs/using-brassy.html                        |  47 ++++++++++++-
 pyproject.toml                                |   1 +
 setup.py                                      |   7 +-
 src/brassy/utils/git_handler.py               |  27 ++++++--
 32 files changed, 281 insertions(+), 143 deletions(-)

diff --git a/docs/.buildinfo b/docs/.buildinfo
index 9bdfed4..7ac87e5 100644
--- a/docs/.buildinfo
+++ b/docs/.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: a7850f5afc0219d7d5902826f4f7f68c
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 94a9c5daefbd8a19dbfea7560a334eda
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/brassy/actions/build_release_notes.html b/docs/_modules/brassy/actions/build_release_notes.html
index 5946ec8..b42f964 100644
--- a/docs/_modules/brassy/actions/build_release_notes.html
+++ b/docs/_modules/brassy/actions/build_release_notes.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.actions.build_release_notes &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -341,7 +341,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/actions/init.html b/docs/_modules/brassy/actions/init.html
index bfd1999..a0387a8 100644
--- a/docs/_modules/brassy/actions/init.html
+++ b/docs/_modules/brassy/actions/init.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.actions.init &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -127,7 +127,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/actions/prune_yaml.html b/docs/_modules/brassy/actions/prune_yaml.html
index 2cd000c..bb9547a 100644
--- a/docs/_modules/brassy/actions/prune_yaml.html
+++ b/docs/_modules/brassy/actions/prune_yaml.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.actions.prune_yaml &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -226,7 +226,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/brassy.html b/docs/_modules/brassy/brassy.html
index e26591a..d0bc1b6 100644
--- a/docs/_modules/brassy/brassy.html
+++ b/docs/_modules/brassy/brassy.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.brassy &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=27fed22d" />
     <script src="../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
@@ -119,7 +119,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/templates/release_yaml_template.html b/docs/_modules/brassy/templates/release_yaml_template.html
index 6dbe410..a431657 100644
--- a/docs/_modules/brassy/templates/release_yaml_template.html
+++ b/docs/_modules/brassy/templates/release_yaml_template.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.templates.release_yaml_template &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -31,7 +31,8 @@
           <div class="body" role="main">
             
   <h1>Source code for brassy.templates.release_yaml_template</h1><div class="highlight"><pre>
-<span></span><span class="kn">import</span> <span class="nn">pathlib</span>
+<span></span><span class="kn">from</span> <span class="nn">brassy.utils.settings_manager</span> <span class="kn">import</span> <span class="n">get_settings</span>
+<span class="kn">import</span> <span class="nn">pathlib</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</span>
 <span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">date</span> <span class="k">as</span> <span class="n">Date</span>
 
@@ -75,7 +76,8 @@ <h1>Source code for brassy.templates.release_yaml_template</h1><div class="highl
 <div class="viewcode-block" id="RelatedInternalIssue">
 <a class="viewcode-back" href="../../../api.html#brassy.templates.release_yaml_template.RelatedInternalIssue">[docs]</a>
 <span class="k">class</span> <span class="nc">RelatedInternalIssue</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
-    <span class="n">string</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">pattern</span><span class="o">=</span><span class="sa">r</span><span class="s2">&quot;[A-Za-z]+#\d+ - .+&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
+    <span class="n">internal</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
+        <span class="n">pattern</span><span class="o">=</span><span class="sa">r</span><span class="s2">&quot;[A-Za-z]+#\d+ - .+&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
 
 
 
@@ -161,8 +163,6 @@ <h1>Source code for brassy.templates.release_yaml_template</h1><div class="highl
 
 
 
-<span class="kn">from</span> <span class="nn">brassy.utils.settings_manager</span> <span class="kn">import</span> <span class="n">get_settings</span>
-
 <span class="n">Settings</span> <span class="o">=</span> <span class="n">get_settings</span><span class="p">(</span><span class="s2">&quot;brassy&quot;</span><span class="p">)</span>
 
 <span class="c1"># List of categories stored in a variable</span>
@@ -225,7 +225,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/templates/settings_template.html b/docs/_modules/brassy/templates/settings_template.html
index bfb2a93..1e97864 100644
--- a/docs/_modules/brassy/templates/settings_template.html
+++ b/docs/_modules/brassy/templates/settings_template.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.templates.settings_template &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -196,7 +196,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/utils/CLI.html b/docs/_modules/brassy/utils/CLI.html
index e972691..6e443ff 100644
--- a/docs/_modules/brassy/utils/CLI.html
+++ b/docs/_modules/brassy/utils/CLI.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.utils.CLI &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -425,7 +425,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/utils/file_handler.html b/docs/_modules/brassy/utils/file_handler.html
index 1872543..2beaa25 100644
--- a/docs/_modules/brassy/utils/file_handler.html
+++ b/docs/_modules/brassy/utils/file_handler.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.utils.file_handler &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -279,7 +279,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/utils/git_handler.html b/docs/_modules/brassy/utils/git_handler.html
index bc68c76..edd5db3 100644
--- a/docs/_modules/brassy/utils/git_handler.html
+++ b/docs/_modules/brassy/utils/git_handler.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.utils.git_handler &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -38,14 +38,26 @@ <h1>Source code for brassy.utils.git_handler</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../../api.html#brassy.utils.git_handler.get_git_status">[docs]</a>
 <span class="k">def</span> <span class="nf">get_git_status</span><span class="p">(</span><span class="n">repo_path</span><span class="o">=</span><span class="s2">&quot;.&quot;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Retrieves the status of files in the given Git repository.</span>
+<span class="sd">    Retrieve the status of files in the specified Git repository.</span>
 
-<span class="sd">    Parameters:</span>
-<span class="sd">    repo_path (str): The path to the Git repository. Defaults to the current directory.</span>
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    repo_path : str, optional</span>
+<span class="sd">        The path to the Git repository. Defaults to the current directory.</span>
 
-<span class="sd">    Returns:</span>
-<span class="sd">    dict: A dictionary with keys &#39;added&#39;, &#39;modified&#39;, &#39;deleted&#39;, and &#39;renamed&#39;,</span>
-<span class="sd">          each containing a list of file paths that match the respective status.</span>
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    dict</span>
+<span class="sd">        A dictionary with the following keys:</span>
+
+<span class="sd">        - &#39;added&#39;: list of str</span>
+<span class="sd">            List of file paths for files that have been added.</span>
+<span class="sd">        - &#39;modified&#39;: list of str</span>
+<span class="sd">            List of file paths for files that have been modified.</span>
+<span class="sd">        - &#39;deleted&#39;: list of str</span>
+<span class="sd">            List of file paths for files that have been deleted.</span>
+<span class="sd">        - &#39;renamed&#39;: list of str</span>
+<span class="sd">            List of file paths for files that have been renamed.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="c1"># Open the repository</span>
@@ -55,7 +67,8 @@ <h1>Source code for brassy.utils.git_handler</h1><div class="highlight"><pre>
     <span class="k">try</span><span class="p">:</span>
         <span class="n">current_branch</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">head</span>
     <span class="k">except</span> <span class="n">pygit2</span><span class="o">.</span><span class="n">GitError</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="n">pygit2</span><span class="o">.</span><span class="n">GitError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">repo_path</span><span class="si">}</span><span class="s2"> is not a git repo or does not have a head&quot;</span><span class="p">)</span>
+        <span class="k">raise</span> <span class="n">pygit2</span><span class="o">.</span><span class="n">GitError</span><span class="p">(</span>
+            <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">repo_path</span><span class="si">}</span><span class="s2"> is not a git repo or does not have a head&quot;</span><span class="p">)</span>
 
     <span class="c1"># Get the main branch reference</span>
     <span class="n">main_branch</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">branches</span><span class="p">[</span><span class="s2">&quot;main&quot;</span><span class="p">]</span>
@@ -178,7 +191,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/utils/messages.html b/docs/_modules/brassy/utils/messages.html
index 76cf156..2458a4b 100644
--- a/docs/_modules/brassy/utils/messages.html
+++ b/docs/_modules/brassy/utils/messages.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.utils.messages &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -207,7 +207,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/brassy/utils/settings_manager.html b/docs/_modules/brassy/utils/settings_manager.html
index ee07195..78ded1c 100644
--- a/docs/_modules/brassy/utils/settings_manager.html
+++ b/docs/_modules/brassy/utils/settings_manager.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>brassy.utils.settings_manager &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
     <script src="../../../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -381,7 +381,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
index a765a46..0d02f77 100644
--- a/docs/_modules/index.html
+++ b/docs/_modules/index.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Overview: module code &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
     <script src="../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -98,7 +98,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/_sources/using-brassy.rst.txt b/docs/_sources/using-brassy.rst.txt
index 20c94cc..43b5255 100644
--- a/docs/_sources/using-brassy.rst.txt
+++ b/docs/_sources/using-brassy.rst.txt
@@ -181,6 +181,56 @@ Would output:
 
 .. literalinclude :: ./examples/basic-usage/new-release-note-header-footer
 
+Related Issue
+-------------
+
+Brassy can link issues (aka tasks, bugs, cards, etc.) to changes.
+
+For example:
+
+.. code-block:: yaml
+
+  continuous integration:
+  - title: 'Delete repo upon push'
+    description: 'I am done coding. Just delete the repo.'
+    files:
+      deleted:
+      - 'main.py'
+      added:
+      - 'delete-everything.py'
+    related-issue:
+      number: 999
+      repo_url: 'https://github.com/torvalds/linux'
+
+links the change "Delete repo upon push" to issue #999 on the linked linux repo.
+
+.. warning::
+
+  Issue information isn't rendered in generated release notes by default.
+  You must (currently) change your release generation template to include
+  issue info in your release notes.
+
+Support for Internal Repos
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Some repositories aren't something you can share a link for.
+For example, they might be on an internal server or on your
+personal laptop.
+
+In these cases, you can specify issues without a URL. They must follow this pattern:
+
+.. code-block::
+
+  Repo Name Or Other String#999 - Description or other string
+
+For example:
+
+.. code-block:: yaml
+
+  related-issue:
+    internal: "Brassy#0 - Fake issue as an example for change"
+
+
 Change YAML directory
 ---------------------
 
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
index e5179b7..d9846da 100644
--- a/docs/_static/basic.css
+++ b/docs/_static/basic.css
@@ -1,12 +1,5 @@
 /*
- * basic.css
- * ~~~~~~~~~
- *
  * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
+    margin-top: 10px;
 }
 
 ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
+    padding: 5px 0;
 }
 
 ul.search li a {
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
index 4d67807..0398ebb 100644
--- a/docs/_static/doctools.js
+++ b/docs/_static/doctools.js
@@ -1,12 +1,5 @@
 /*
- * doctools.js
- * ~~~~~~~~~~~
- *
  * Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 
diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
index 367b8ed..c7fe6c6 100644
--- a/docs/_static/language_data.js
+++ b/docs/_static/language_data.js
@@ -1,13 +1,6 @@
 /*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index b08d58c..2c774d1 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -1,12 +1,5 @@
 /*
- * searchtools.js
- * ~~~~~~~~~~~~~~~~
- *
  * Sphinx JavaScript utilities for the full-text search.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 
@@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") {
     // and returns the new score.
     /*
     score: result => {
-      const [docname, title, anchor, descr, score, filename] = result
+      const [docname, title, anchor, descr, score, filename, kind] = result
       return score
     },
     */
@@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") {
   };
 }
 
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+    static get index() { return  "index"; }
+    static get object() { return "object"; }
+    static get text() { return "text"; }
+    static get title() { return "title"; }
+}
+
 const _removeChildren = (element) => {
   while (element && element.lastChild) element.removeChild(element.lastChild);
 };
@@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
   const contentRoot = document.documentElement.dataset.content_root;
 
-  const [docName, title, anchor, descr, score, _filename] = item;
+  const [docName, title, anchor, descr, score, _filename, kind] = item;
 
   let listItem = document.createElement("li");
+  // Add a class representing the item's type:
+  // can be used by a theme's CSS selector for styling
+  // See SearchResultKind for the class names.
+  listItem.classList.add(`kind-${kind}`);
   let requestUrl;
   let linkUrl;
   if (docBuilder === "dirhtml") {
@@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => {
       "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
     );
   else
-    Search.status.innerText = _(
-      "Search finished, found ${resultCount} page(s) matching the search query."
+    Search.status.innerText = Documentation.ngettext(
+      "Search finished, found one page matching the search query.",
+      "Search finished, found ${resultCount} pages matching the search query.",
+      resultCount,
     ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
@@ -138,7 +145,7 @@ const _displayNextItem = (
   else _finishSearch(resultCount);
 };
 // Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
 // Order the results by score (in opposite order of appearance, since the
 // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
 const _orderResultsByScoreThenName = (a, b) => {
@@ -248,6 +255,7 @@ const Search = {
     searchSummary.classList.add("search-summary");
     searchSummary.innerText = "";
     const searchList = document.createElement("ul");
+    searchList.setAttribute("role", "list");
     searchList.classList.add("search");
 
     const out = document.getElementById("search-results");
@@ -318,7 +326,7 @@ const Search = {
     const indexEntries = Search._index.indexentries;
 
     // Collect multiple result groups to be sorted separately and then ordered.
-    // Each is an array of [docname, title, anchor, descr, score, filename].
+    // Each is an array of [docname, title, anchor, descr, score, filename, kind].
     const normalResults = [];
     const nonMainIndexResults = [];
 
@@ -337,6 +345,7 @@ const Search = {
             null,
             score + boost,
             filenames[file],
+            SearchResultKind.title,
           ]);
         }
       }
@@ -354,6 +363,7 @@ const Search = {
             null,
             score,
             filenames[file],
+            SearchResultKind.index,
           ];
           if (isMain) {
             normalResults.push(result);
@@ -475,6 +485,7 @@ const Search = {
         descr,
         score,
         filenames[match[0]],
+        SearchResultKind.object,
       ]);
     };
     Object.keys(objects).forEach((prefix) =>
@@ -585,6 +596,7 @@ const Search = {
         null,
         score,
         filenames[file],
+        SearchResultKind.text,
       ]);
     }
     return results;
diff --git a/docs/api.html b/docs/api.html
index 302bfc0..82c530f 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -7,10 +7,10 @@
 
     <title>API &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -404,8 +404,13 @@ <h3>Templates<a class="headerlink" href="#templates" title="Link to this heading
 
 <dl class="py class">
 <dt class="sig sig-object py" id="brassy.templates.release_yaml_template.RelatedInternalIssue">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">brassy.templates.release_yaml_template.</span></span><span class="sig-name descname"><span class="pre">RelatedInternalIssue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_PydanticGeneralMetadata</span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">pattern</span></span><span class="o"><span class="pre">=</span></span><span class="s"><span class="pre">'[A-Za-z]+#\\d+</span> <span class="pre">-</span> <span class="pre">.+'</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/brassy/templates/release_yaml_template.html#RelatedInternalIssue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">brassy.templates.release_yaml_template.</span></span><span class="sig-name descname"><span class="pre">RelatedInternalIssue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_PydanticGeneralMetadata</span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">pattern</span></span><span class="o"><span class="pre">=</span></span><span class="s"><span class="pre">'[A-Za-z]+#\\d+</span> <span class="pre">-</span> <span class="pre">.+'</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/brassy/templates/release_yaml_template.html#RelatedInternalIssue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="brassy.templates.release_yaml_template.RelatedInternalIssue.internal">
+<span class="sig-name descname"><span class="pre">internal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue.internal" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="brassy.templates.release_yaml_template.RelatedInternalIssue.model_computed_fields">
 <span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ComputedFieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue.model_computed_fields" title="Link to this definition">¶</a></dt>
@@ -420,17 +425,12 @@ <h3>Templates<a class="headerlink" href="#templates" title="Link to this heading
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="brassy.templates.release_yaml_template.RelatedInternalIssue.model_fields">
-<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'string':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None,</span> <span class="pre">metadata=[_PydanticGeneralMetadata(pattern='[A-Za-z]+#\\d+</span> <span class="pre">-</span> <span class="pre">.+')])}</span></em><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue.model_fields" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'internal':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None,</span> <span class="pre">metadata=[_PydanticGeneralMetadata(pattern='[A-Za-z]+#\\d+</span> <span class="pre">-</span> <span class="pre">.+')])}</span></em><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue.model_fields" title="Link to this definition">¶</a></dt>
 <dd><p>Metadata about the fields defined on the model,
 mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p>
 <p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
 </dd></dl>
 
-<dl class="py attribute">
-<dt class="sig sig-object py" id="brassy.templates.release_yaml_template.RelatedInternalIssue.string">
-<span class="sig-name descname"><span class="pre">string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#brassy.templates.release_yaml_template.RelatedInternalIssue.string" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
 </dd></dl>
 
 <dl class="py class">
@@ -734,14 +734,41 @@ <h3>Utils<a class="headerlink" href="#utils" title="Link to this heading">¶</a>
 <dl class="py function">
 <dt class="sig sig-object py" id="brassy.utils.git_handler.get_git_status">
 <span class="sig-prename descclassname"><span class="pre">brassy.utils.git_handler.</span></span><span class="sig-name descname"><span class="pre">get_git_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'.'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/brassy/utils/git_handler.html#get_git_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brassy.utils.git_handler.get_git_status" title="Link to this definition">¶</a></dt>
-<dd><p>Retrieves the status of files in the given Git repository.</p>
-<p>Parameters:
-repo_path (str): The path to the Git repository. Defaults to the current directory.</p>
-<p>Returns:
-dict: A dictionary with keys ‘added’, ‘modified’, ‘deleted’, and ‘renamed’,</p>
-<blockquote>
-<div><p>each containing a list of file paths that match the respective status.</p>
-</div></blockquote>
+<dd><p>Retrieve the status of files in the specified Git repository.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>repo_path</strong> (<em>str</em><em>, </em><em>optional</em>) – The path to the Git repository. Defaults to the current directory.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p>A dictionary with the following keys:</p>
+<ul class="simple">
+<li><dl class="simple">
+<dt>’added’: list of str</dt><dd><p>List of file paths for files that have been added.</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt>’modified’: list of str</dt><dd><p>List of file paths for files that have been modified.</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt>’deleted’: list of str</dt><dd><p>List of file paths for files that have been deleted.</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt>’renamed’: list of str</dt><dd><p>List of file paths for files that have been renamed.</p>
+</dd>
+</dl>
+</li>
+</ul>
+</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>dict</p>
+</dd>
+</dl>
 </dd></dl>
 
 <dl class="py function">
@@ -1043,7 +1070,7 @@ <h3>Utils<a class="headerlink" href="#utils" title="Link to this heading">¶</a>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="brassy.utils.file_handler.get_yaml_template_path">
-<span class="sig-prename descclassname"><span class="pre">brassy.utils.file_handler.</span></span><span class="sig-name descname"><span class="pre">get_yaml_template_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path_arg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/Users/gwynu/Documents/yaml-to-release-note/sphinx'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/brassy/utils/file_handler.html#get_yaml_template_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brassy.utils.file_handler.get_yaml_template_path" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">brassy.utils.file_handler.</span></span><span class="sig-name descname"><span class="pre">get_yaml_template_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path_arg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/workspaces/yaml-to-release-note/sphinx'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/brassy/utils/file_handler.html#get_yaml_template_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#brassy.utils.file_handler.get_yaml_template_path" title="Link to this definition">¶</a></dt>
 <dd><p>Returns the path of the YAML template file based on the given file path argument.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -1193,7 +1220,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/docs/genindex.html b/docs/genindex.html
index a6f293a..e17831b 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Index &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" />
@@ -283,6 +283,8 @@ <h2 id="I">I</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#brassy.utils.messages.init_logger">init_logger() (in module brassy.utils.messages)</a>
+</li>
+      <li><a href="api.html#brassy.templates.release_yaml_template.RelatedInternalIssue.internal">internal (brassy.templates.release_yaml_template.RelatedInternalIssue attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -466,8 +468,6 @@ <h2 id="S">S</h2>
       <li><a href="api.html#brassy.utils.messages.setup_messages">setup_messages() (in module brassy.utils.messages)</a>
 </li>
       <li><a href="api.html#brassy.templates.release_yaml_template.DateRange.start">start (brassy.templates.release_yaml_template.DateRange attribute)</a>
-</li>
-      <li><a href="api.html#brassy.templates.release_yaml_template.RelatedInternalIssue.string">string (brassy.templates.release_yaml_template.RelatedInternalIssue attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -570,7 +570,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/index.html b/docs/index.html
index 3e5b823..9d4ab3a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -7,10 +7,10 @@
 
     <title>Welcome to brassy’s documentation! &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -39,6 +39,7 @@ <h1>Welcome to brassy’s documentation!<a class="headerlink" href="#welcome-to-
 <li class="toctree-l1"><a class="reference internal" href="using-brassy.html">Using Brassy</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="using-brassy.html#example-usage">Example usage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-brassy.html#generate-release-notes">Generate release notes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using-brassy.html#related-issue">Related Issue</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-brassy.html#change-yaml-directory">Change YAML directory</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-brassy.html#prune-yaml-file">Prune YAML file</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using-brassy.html#controlling-cli-output">Controlling CLI Output</a></li>
@@ -124,7 +125,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/docs/objects.inv b/docs/objects.inv
index e6dce5c9b6853375f30e270664f5cc1c25e763e9..3644177ca6cc3fd4c877ef86274789ece0a71f74 100644
GIT binary patch
delta 968
zcmV;(12_Dv3$6>0uL&ZG^PAD|&+qJ!xLgPP{t_f;_vMot0ZB$rsA_wh18{%(Fh)Sa
zudxYef1ww$*Qz3SzivnPu=quSI$3lg@ey{#W1YW%$?tqO+2XS!76Of?1vDV#tPPM_
z>=wHQACsy9MFDt|@BthF+mj6fR(}&$$>C|KpqJCzXT7D8-)Eep|B{rA>;v5iDnAUi
zaI?mvGxFlCx@c=I-io<ws$JOTCdF!~6=`&;-s(z!S2l&{I@F@dxN?$E7#Hj*aT~DK
zox#l5%U&V6(Ec1C$2HZ9sQj+aUs_^btGaQ|WOpQzRxmS-S8ft$Y`l|rjem`0FB5mC
z@SzCj@ZYs1DHM3g%G<+CcdlD1&B3IO78lTa+6YS~pR+{xn6Q<Op!*@KruMLahdwu?
z>$`@0<n};nUZ?*ekaQ=2z+(-XS0F9L&H&UldI16KDHpgc3kRu$ah=@5BE!+MUQ&!l
z&%hUoysw;`+~7D@D527~>3;(ioV9l?W+D3cbT^g@leg#VV^$QsK@N}Hok|ccgHx)@
z#&x+dml7w6yTS3dPyV{epY|7mBNQbc4f01#I@+wi$S@&*c<14aYgz_s+(cRO0NS`w
zl1fHgW}^_17bU^aXB}n8L`d2A)*o8tg$BPM^E<*$m{E5_PeA)t>3@OU^c2s+_}HL{
zr$JES4bCfCD?QYFcdHi<{HQs8m1-<XEiO?dcDqT<HZb%FE*h;-t;CgMMOhrC#Nbix
z*;t%s%_KzV0+<XB>MqUWnyUh1XgU5r4bH9nSL~F+6)vt+uq)NrDxKTd5Ijut;y_gG
zuD#;{?uwZRRhCnXaeta<YB!%76(Oq&^I<wi+4qxEMI|j`wRvgX4J%<)64yblSYGTW
zkeNqv67|O=S}8jZg+lwsUF#2miyP>kq;`dADD9k_EPaNbH*10q#>JXWh^#>4&e2W8
zevrSA;f&8$ILT|y0QU;m=zbRj@_}n5+pWq2)!c1hX87>4-G9hlgAbXp><v>zwm!Yf
ze!SnVN|0PKc=Qzn-GOjby3$Z@>;7Dws<oU!jlV(Q?gcWdvJm#CfB!QX*7NHm>Vo=W
z<!(!^UDd~R_ad-<3xi2;I(Ykn+5OQT@YBz%+mj6Q?Iz#kH^bP^-vq+@ur$j;<ySYG
zoA1|~*Xzv>Us0cfZl49+UW0D4SAP^%xwG7x+ix-l9pJ8Vdj2Nh+Vh#r9WI)c0jhBZ
qKTAd^3$@>c_xGrhRbx;y>-K+g2405c!RjwplKtdMR{sMN=)7~%{O+9q

delta 966
zcmV;%13CPz3#<!}uL*35^PAD|&u{OMxLgN({}Lo<_vVuu0ZB$9RJA?M0l1Goj1iFV
zZ)^hEf9QqmwW`S7uiFtmEWVMTP8OX=e1u)`Sm!Tb@;l#6w)ou<3xP({0veEV)&@u|
zc8gtuUz4f<MFDw}@BthF+LH|eR)2FjIegYzDs_Cu$--}P+83q5r)**$;!aTcVX%Rl
zH5#3f7Z=T<Vp&uq9xj_|7dE*`u^MVc8Z8omUFq-2rVw3+T2vWVP7(^^f;}Z}1J=3|
zm>E0SD?}ICp9AE$rg{;T-}U)ROU!FkH|{&x9f_nB%uM5zn*<sg?<8JhV}IGp#N8=;
zD8f1XcWp@u1zxi9_9)Yx>Xu4#FsY-(<@264!jj3SED=5?Y@{RTe#ok+JuKj%&kgDN
zt|1?}J&>B$>E8$>-3cJ@ScB#jNK3IZ0JV)?KmdEn1#Zg1F)CqPC-<<(aP+K~6ywn|
z@P#7pD<>y6IL;MHsPt|6Kz{{i?M;hWh(12ujpf4R?dkfM6-955!y|WR5`@d(l<Kl^
zU2e>k#EIhWZ~Wbpzijen{e|ENMaf5l{6UkBHtVl3Ob8&}c{t&kmVp{KQI<S_Hg1%p
zk`b5LC`9BnNig(TM;S5^QZ~Nzhn9Jv!7s@Cj<6GE)XmTn(7siAV1G9~#j`LzHfZ8$
z5R`a>^NQ9=4>jN2>BR#-YL0KE8jDhkOH_&7Zc?)i41I!&Mr%|naphQ17KbS@c$E8Y
zEY7oL5+ZZ~Ooj(_SLSieRe>?I9RE9mb1VNAJEd@iiz^lEN;S4h=QcJ357WFj5LLTN
z?|6W_U?xJ9<rHI_CV!gR&F4l%$m+s;n9fo5{p3_pNy}JmURrm<N?4V|b&xBT7yAih
z=8>F4{c(v_%FaWf(Ef3k`h(!&2D&GyU11tZJ0~YgpW)}tn&5?Tv8EFuE6})ebQ7^3
z<S%46<MkCz@|rWiy#hA6-vxnu;9ALctMWiKcN>@)KKyJqvVYg$m&{o9hN&W3pPpqu
z-fveWNG=&X`U-;XK)5PhX{fh#A6KVpEoV^UZxFb9fy}Bbg#GE?|4fGU{5pxcpuSkS
zyOL{H^>N)j2&~`2U=o}Tp1xpqf3ydD^)u`CB*T2W$v64UF!u8&f$%;o&9YGW)y?MS
z`}OAadh^5A=TD&9XF<2upxf-#AB9!!EcfR2o6JE6xT~C=KMA<@d?s^;i)LkjYMjB(
ok`c;6?RVk%J*s5Y7}U(V{YB2e%dk9H{pCuspM1&cf8xKpt%-!_00000

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 72ff61b..8dcc39c 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -6,10 +6,10 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Python Module Index &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -162,7 +162,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/releases/0.0.2.html b/docs/releases/0.0.2.html
index 00eab13..0aa0ac8 100644
--- a/docs/releases/0.0.2.html
+++ b/docs/releases/0.0.2.html
@@ -7,10 +7,10 @@
 
     <title>Version 0.0.2 (2024-08-09) &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
     <script src="../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -168,7 +168,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/docs/releases/0.0.3.html b/docs/releases/0.0.3.html
index 3552bf7..87d4baa 100644
--- a/docs/releases/0.0.3.html
+++ b/docs/releases/0.0.3.html
@@ -7,10 +7,10 @@
 
     <title>Version 0.0.3 (October 23, 2024) &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
     <script src="../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -311,7 +311,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/docs/releases/index.html b/docs/releases/index.html
index a3e5236..b9109c3 100644
--- a/docs/releases/index.html
+++ b/docs/releases/index.html
@@ -7,10 +7,10 @@
 
     <title>Release Notes &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
     <script src="../_static/documentation_options.js?v=47de8214"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -119,7 +119,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/docs/search.html b/docs/search.html
index 005e082..51eff8b 100644
--- a/docs/search.html
+++ b/docs/search.html
@@ -6,11 +6,11 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Search &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/searchtools.js"></script>
     <script src="_static/language_data.js"></script>
@@ -110,7 +110,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
     </div>
diff --git a/docs/searchindex.js b/docs/searchindex.js
index edf64a6..ab4aeca 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API": [[0, null]], "Actions": [[0, "actions"]], "Add integration tests": [[3, "add-integration-tests"]], "Add internal option to related issue": [[3, "add-internal-option-to-related-issue"]], "Add start and finish dates for changes": [[3, "add-start-and-finish-dates-for-changes"]], "Add \u2013get-changed-files": [[2, "add-get-changed-files"]], "Add \u2013init that writes out config files": [[3, "add-init-that-writes-out-config-files"]], "Added new templating integration test": [[3, "added-new-templating-integration-test"]], "Added \u2013output-to-console": [[2, "added-output-to-console"]], "Adding Headers and/or Footers": [[5, "adding-headers-and-or-footers"]], "Allow entries to have no field and no title": [[3, "allow-entries-to-have-no-field-and-no-title"]], "Allow users to disable pipe on description field": [[3, "allow-users-to-disable-pipe-on-description-field"]], "Bug fix": [[2, "bug-fix"], [3, "bug-fix"], [3, "id6"], [3, "id7"], [3, "id8"], [3, "id9"], [3, "id10"]], "Build Release Notes": [[0, "module-brassy.actions.build_release_notes"]], "Builds now have sections with either a missing title or description": [[3, "builds-now-have-sections-with-either-a-missing-title-or-description"]], "CLI": [[0, "module-brassy.utils.CLI"]], "Change YAML directory": [[5, "change-yaml-directory"]], "Code Docstrings": [[0, "code-docstrings"]], "Continuous integration": [[3, "continuous-integration"], [3, "id12"]], "Controlling CLI Output": [[5, "controlling-cli-output"]], "Create YAML template": [[5, "create-yaml-template"]], "Documentation": [[3, "documentation"], [3, "id11"]], "Documentation updated for new version": [[3, "documentation-updated-for-new-version"]], "Empty file change lines removed from output": [[2, "empty-file-change-lines-removed-from-output"]], "Enable building without writing to file": [[2, "enable-building-without-writing-to-file"]], "Enhancement": [[2, "enhancement"], [3, "enhancement"], [3, "id1"], [3, "id2"], [3, "id3"], [3, "id4"], [3, "id5"]], "Example usage": [[5, "example-usage"]], "File Handler": [[0, "module-brassy.utils.file_handler"]], "Fix bug with \u2013write-template-error": [[3, "fix-bug-with-write-template-error"]], "Fix docs rendering of examples.": [[3, "fix-docs-rendering-of-examples"]], "Fix empty \u201c\u2013write-yaml-template bug": [[3, "fix-empty-write-yaml-template-bug"]], "Fixed quiet not being quiet.": [[2, "fixed-quiet-not-being-quiet"]], "Generate release notes": [[5, "generate-release-notes"]], "Generating the changed files via git": [[5, "generating-the-changed-files-via-git"]], "Help!": [[5, "help"]], "Implement default path": [[3, "implement-default-path"]], "Indices and tables": [[1, "indices-and-tables"]], "Initialize": [[0, "module-brassy.actions.init"]], "Main Module": [[0, "module-brassy.brassy"]], "Make optional dates optional": [[3, "make-optional-dates-optional"]], "Messages": [[0, "module-brassy.utils.messages"]], "Print pretty error on blank yaml.": [[3, "print-pretty-error-on-blank-yaml"]], "Prune YAML": [[0, "module-brassy.actions.prune_yaml"]], "Prune YAML file": [[5, "prune-yaml-file"]], "Put title at top of template": [[3, "put-title-at-top-of-template"]], "Release Notes": [[4, null]], "Release YAML": [[0, "module-brassy.templates.release_yaml_template"]], "Settings": [[0, "module-brassy.templates.settings_template"]], "Settings Manager": [[0, "module-brassy.utils.settings_manager"]], "Specifying Date": [[5, "specifying-date"]], "Specifying Version": [[5, "specifying-version"]], "Templates": [[0, "templates"]], "Using Brassy": [[5, null]], "Utils": [[0, "utils"]], "Version 0.0.1": [[4, "version-0-0-1"]], "Version 0.0.2": [[4, "version-0-0-2"]], "Version 0.0.2 (2024-08-09)": [[2, null]], "Version 0.0.3": [[4, "version-0-0-3"]], "Version 0.0.3 (October 23, 2024)": [[3, null]], "Welcome to brassy\u2019s documentation!": [[1, null]], "git_handler": [[0, "module-brassy.utils.git_handler"]]}, "docnames": ["api", "index", "releases/0.0.2", "releases/0.0.3", "releases/index", "using-brassy"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst", "releases/0.0.2.rst", "releases/0.0.3.rst", "releases/index.rst", "using-brassy.rst"], "indexentries": {"added (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.added", false]], "blank_string() (brassy.templates.release_yaml_template.relatedissue method)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.blank_string", false]], "brassy.actions.build_release_notes": [[0, "module-brassy.actions.build_release_notes", false]], "brassy.actions.init": [[0, "module-brassy.actions.init", false]], "brassy.actions.prune_yaml": [[0, "module-brassy.actions.prune_yaml", false]], "brassy.brassy": [[0, "module-brassy.brassy", false]], "brassy.templates.release_yaml_template": [[0, "module-brassy.templates.release_yaml_template", false]], "brassy.templates.settings_template": [[0, "module-brassy.templates.settings_template", false]], "brassy.utils.cli": [[0, "module-brassy.utils.CLI", false]], "brassy.utils.file_handler": [[0, "module-brassy.utils.file_handler", false]], "brassy.utils.git_handler": [[0, "module-brassy.utils.git_handler", false]], "brassy.utils.messages": [[0, "module-brassy.utils.messages", false]], "brassy.utils.settings_manager": [[0, "module-brassy.utils.settings_manager", false]], "build_release_notes() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.build_release_notes", false]], "change_categories (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.change_categories", false]], "changeitem (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.ChangeItem", false]], "check_at_least_one_field() (brassy.templates.release_yaml_template.files method)": [[0, "brassy.templates.release_yaml_template.Files.check_at_least_one_field", false]], "create_blank_template_yaml_file() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.create_blank_template_yaml_file", false]], "create_config_file() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.create_config_file", false]], "date (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.date", false]], "daterange (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.DateRange", false]], "default_description (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_description", false]], "default_title (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_title", false]], "default_yaml_path (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_yaml_path", false]], "deleted (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.deleted", false]], "description (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.description", false]], "description_populates_with_pipe (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.description_populates_with_pipe", false]], "direct_pruning_of_files() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.direct_pruning_of_files", false]], "empty_str_to_none() (brassy.templates.release_yaml_template.changeitem method)": [[0, "brassy.templates.release_yaml_template.ChangeItem.empty_str_to_none", false]], "enable_experimental_features (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.enable_experimental_features", false]], "exit_on_invalid_arguments() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.exit_on_invalid_arguments", false]], "fail_on_empty_dir (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.fail_on_empty_dir", false]], "files (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.files", false]], "files (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.Files", false]], "find_duplicate_titles() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.find_duplicate_titles", false]], "finish (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.finish", false]], "format_files_changed_entry() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.format_files_changed_entry", false]], "format_release_notes() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.format_release_notes", false]], "generate_file_change_section_list_of_strings() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.generate_file_change_section_list_of_strings", false]], "generate_section_string() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.generate_section_string", false]], "get_boolean_prompt_function() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.get_boolean_prompt_function", false]], "get_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_config_files", false]], "get_current_git_branch() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.get_current_git_branch", false]], "get_file_list_from_cli_input() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_file_list_from_cli_input", false]], "get_git_repo_root() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_git_repo_root", false]], "get_git_status() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.get_git_status", false]], "get_header_footer() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.get_header_footer", false]], "get_parser() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_parser", false]], "get_project_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_project_config_file_path", false]], "get_rich_opener() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.get_rich_opener", false]], "get_settings() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_settings", false]], "get_settings_from_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_settings_from_config_files", false]], "get_site_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_site_config_file_path", false]], "get_user_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_user_config_file_path", false]], "get_yaml_files_from_input() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_yaml_files_from_input", false]], "get_yaml_template_path() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.get_yaml_template_path", false]], "init() (in module brassy.actions.init)": [[0, "brassy.actions.init.init", false]], "init_logger() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.init_logger", false]], "merge_and_validate_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.merge_and_validate_config_files", false]], "model_computed_fields (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_computed_fields", false]], "model_computed_fields (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_computed_fields", false]], "model_computed_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_computed_fields", false]], "model_config (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_config", false]], "model_config (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_config", false]], "model_config (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_config", false]], "model_config (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_config", false]], "model_config (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_config", false]], "model_config (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_config", false]], "model_config (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_config", false]], "model_config (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_config", false]], "model_fields (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_fields", false]], "model_fields (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_fields", false]], "model_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_fields", false]], "modified (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.modified", false]], "module": [[0, "module-brassy.actions.build_release_notes", false], [0, "module-brassy.actions.init", false], [0, "module-brassy.actions.prune_yaml", false], [0, "module-brassy.brassy", false], [0, "module-brassy.templates.release_yaml_template", false], [0, "module-brassy.templates.settings_template", false], [0, "module-brassy.utils.CLI", false], [0, "module-brassy.utils.file_handler", false], [0, "module-brassy.utils.git_handler", false], [0, "module-brassy.utils.messages", false], [0, "module-brassy.utils.settings_manager", false]], "moved (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.moved", false]], "number (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.number", false]], "override_dict_with_environmental_variables() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.override_dict_with_environmental_variables", false]], "parse_arguments() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.parse_arguments", false]], "parse_date() (brassy.templates.release_yaml_template.daterange class method)": [[0, "brassy.templates.release_yaml_template.DateRange.parse_date", false]], "populate_by_name (brassy.templates.settings_template.releasetemplate.config attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.Config.populate_by_name", false]], "print_out_git_changed_files() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.print_out_git_changed_files", false]], "print_version_and_exit() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.print_version_and_exit", false]], "prune_empty() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.prune_empty", false]], "prune_yaml_file() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.prune_yaml_file", false]], "read_config_file() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.read_config_file", false]], "read_yaml_files() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.read_yaml_files", false]], "related_issue (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.related_issue", false]], "relatedinternalissue (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue", false]], "relatedissue (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.RelatedIssue", false]], "release_template (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.release_template", false]], "releasenote (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.ReleaseNote", false]], "releasetemplate (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.ReleaseTemplate", false]], "releasetemplate.config (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.ReleaseTemplate.Config", false]], "repo_url (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.repo_url", false]], "run_from_cli() (in module brassy.brassy)": [[0, "brassy.brassy.run_from_CLI", false]], "run_from_cli() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.run_from_CLI", false]], "settingstemplate (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.SettingsTemplate", false]], "setup_console() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.setup_console", false]], "setup_messages() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.setup_messages", false]], "start (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.start", false]], "string (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.string", false]], "templates (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.templates", false]], "title (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.title", false]], "use_color (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.use_color", false]], "valid_changes (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.valid_changes", false]], "valid_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.valid_fields", false]], "value_error_on_invalid_yaml() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.value_error_on_invalid_yaml", false]], "write_output_file() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.write_output_file", false]]}, "objects": {"brassy": [[0, 0, 0, "-", "brassy"]], "brassy.actions": [[0, 0, 0, "-", "build_release_notes"], [0, 0, 0, "-", "init"], [0, 0, 0, "-", "prune_yaml"]], "brassy.actions.build_release_notes": [[0, 1, 1, "", "build_release_notes"], [0, 1, 1, "", "find_duplicate_titles"], [0, 1, 1, "", "format_files_changed_entry"], [0, 1, 1, "", "format_release_notes"], [0, 1, 1, "", "generate_file_change_section_list_of_strings"], [0, 1, 1, "", "generate_section_string"], [0, 1, 1, "", "get_header_footer"]], "brassy.actions.init": [[0, 1, 1, "", "init"]], "brassy.actions.prune_yaml": [[0, 1, 1, "", "direct_pruning_of_files"], [0, 1, 1, "", "prune_empty"], [0, 1, 1, "", "prune_yaml_file"]], "brassy.brassy": [[0, 1, 1, "", "run_from_CLI"]], "brassy.templates": [[0, 0, 0, "-", "release_yaml_template"], [0, 0, 0, "-", "settings_template"]], "brassy.templates.release_yaml_template": [[0, 2, 1, "", "ChangeItem"], [0, 2, 1, "", "DateRange"], [0, 2, 1, "", "Files"], [0, 2, 1, "", "RelatedInternalIssue"], [0, 2, 1, "", "RelatedIssue"], [0, 2, 1, "", "ReleaseNote"]], "brassy.templates.release_yaml_template.ChangeItem": [[0, 3, 1, "", "date"], [0, 3, 1, "", "description"], [0, 4, 1, "", "empty_str_to_none"], [0, 3, 1, "", "files"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "related_issue"], [0, 3, 1, "", "title"]], "brassy.templates.release_yaml_template.DateRange": [[0, 3, 1, "", "finish"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 4, 1, "", "parse_date"], [0, 3, 1, "", "start"]], "brassy.templates.release_yaml_template.Files": [[0, 3, 1, "", "added"], [0, 4, 1, "", "check_at_least_one_field"], [0, 3, 1, "", "deleted"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "modified"], [0, 3, 1, "", "moved"]], "brassy.templates.release_yaml_template.RelatedInternalIssue": [[0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "string"]], "brassy.templates.release_yaml_template.RelatedIssue": [[0, 4, 1, "", "blank_string"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "number"], [0, 3, 1, "", "repo_url"]], "brassy.templates.release_yaml_template.ReleaseNote": [[0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"]], "brassy.templates.settings_template": [[0, 2, 1, "", "ReleaseTemplate"], [0, 2, 1, "", "SettingsTemplate"]], "brassy.templates.settings_template.ReleaseTemplate": [[0, 2, 1, "", "Config"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "release_template"]], "brassy.templates.settings_template.ReleaseTemplate.Config": [[0, 3, 1, "", "populate_by_name"]], "brassy.templates.settings_template.SettingsTemplate": [[0, 3, 1, "", "change_categories"], [0, 3, 1, "", "default_description"], [0, 3, 1, "", "default_title"], [0, 3, 1, "", "default_yaml_path"], [0, 3, 1, "", "description_populates_with_pipe"], [0, 3, 1, "", "enable_experimental_features"], [0, 3, 1, "", "fail_on_empty_dir"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "templates"], [0, 3, 1, "", "use_color"], [0, 3, 1, "", "valid_changes"], [0, 3, 1, "", "valid_fields"]], "brassy.utils": [[0, 0, 0, "-", "CLI"], [0, 0, 0, "-", "file_handler"], [0, 0, 0, "-", "git_handler"], [0, 0, 0, "-", "messages"], [0, 0, 0, "-", "settings_manager"]], "brassy.utils.CLI": [[0, 1, 1, "", "exit_on_invalid_arguments"], [0, 1, 1, "", "get_file_list_from_cli_input"], [0, 1, 1, "", "get_parser"], [0, 1, 1, "", "get_yaml_files_from_input"], [0, 1, 1, "", "parse_arguments"], [0, 1, 1, "", "print_version_and_exit"], [0, 1, 1, "", "run_from_CLI"]], "brassy.utils.file_handler": [[0, 1, 1, "", "create_blank_template_yaml_file"], [0, 1, 1, "", "get_yaml_template_path"], [0, 1, 1, "", "read_yaml_files"], [0, 1, 1, "", "value_error_on_invalid_yaml"], [0, 1, 1, "", "write_output_file"]], "brassy.utils.git_handler": [[0, 1, 1, "", "get_current_git_branch"], [0, 1, 1, "", "get_git_status"], [0, 1, 1, "", "print_out_git_changed_files"]], "brassy.utils.messages": [[0, 1, 1, "", "get_boolean_prompt_function"], [0, 1, 1, "", "get_rich_opener"], [0, 1, 1, "", "init_logger"], [0, 1, 1, "", "setup_console"], [0, 1, 1, "", "setup_messages"]], "brassy.utils.settings_manager": [[0, 1, 1, "", "create_config_file"], [0, 1, 1, "", "get_config_files"], [0, 1, 1, "", "get_git_repo_root"], [0, 1, 1, "", "get_project_config_file_path"], [0, 1, 1, "", "get_settings"], [0, 1, 1, "", "get_settings_from_config_files"], [0, 1, 1, "", "get_site_config_file_path"], [0, 1, 1, "", "get_user_config_file_path"], [0, 1, 1, "", "merge_and_validate_config_files"], [0, 1, 1, "", "override_dict_with_environmental_variables"], [0, 1, 1, "", "read_config_file"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [0, 5], "0": [0, 1, 5], "02": 5, "08": 4, "09": 4, "1": [0, 1, 5], "10": 5, "100000": 5, "1938": 5, "1999": 5, "2": [0, 1], "2024": [4, 5], "2026": 5, "2083": 0, "21": 5, "22": 5, "23": 4, "3": 1, "30": 5, "3000": 5, "575": 3, "822": 0, "A": [0, 3, 5], "By": 5, "For": [0, 2, 5], "If": [0, 5], "In": 2, "It": [0, 2, 5], "NO": 0, "NOT": 3, "No": [3, 4], "Not": 3, "OR": [3, 5], "The": [0, 3, 5], "To": 5, "__fields__": 0, "__init__": 3, "_pydanticgeneralmetadata": 0, "about": 0, "absolut": 0, "accept": [2, 5], "access": 3, "action": 3, "ad": 0, "add": [0, 5], "address": 0, "after": 5, "against": 5, "alia": 0, "alias_prior": 0, "all": [0, 5], "allowed_schem": 0, "also": [0, 5], "alwai": 5, "an": [0, 2, 3, 5], "ani": [0, 5], "annoi": 5, "annot": 0, "api": [1, 3], "app_nam": 0, "append": 5, "appli": 0, "applic": 0, "appreci": 5, "appropri": 0, "ar": [0, 2, 3, 5], "arg": 0, "argpars": 0, "argument": [0, 2, 3, 5], "argumentpars": 0, "assist": 5, "associ": 0, "avail": [0, 5], "b": 0, "back": 0, "backward": 3, "bar": 0, "barebon": 3, "base": 0, "basemodel": 0, "basic": 3, "becaus": [2, 3], "becom": 5, "been": [2, 3, 5], "behaviour": 3, "being": 0, "blank": [0, 2, 5], "blank_str": 0, "bold": 5, "bool": 0, "branch": [0, 2, 5], "brassi": [0, 2, 3], "break": 3, "bug": [0, 5], "build_release_not": [0, 3], "built": 3, "burger": 3, "c": [0, 5], "can": [0, 3, 5], "cannot": 3, "case": 0, "cat": 0, "categor": 0, "categori": 0, "caus": 3, "chang": [0, 1], "change_categori": 0, "change_typ": 0, "changeitem": 0, "changelog_entri": 0, "charact": 0, "check": [0, 3, 5], "check_at_least_one_field": 0, "ci": 3, "class": [0, 3], "classmethod": 0, "classvar": 0, "cli": [1, 3], "code": [1, 5], "codebas": 3, "collect": 0, "color": 5, "com": [0, 5], "combo": 3, "command": [0, 5], "compar": [2, 5], "compat": [0, 3], "comput": 0, "computedfieldinfo": 0, "config": [0, 5], "config1": 0, "config2": 0, "config_fil": 0, "configdict": 0, "configur": [0, 5], "conform": 0, "consid": [0, 5], "consol": [0, 5], "contact": 5, "contain": [0, 5], "content": [0, 3], "continu": [0, 5], "control": 1, "copi": [2, 5], "correct": 0, "correspond": 0, "cpp": 5, "crash": 5, "creat": [0, 3], "create_blank_template_yaml_fil": 0, "create_config_fil": 0, "create_file_if_not_exist": 0, "current": [0, 2, 5], "cute": 0, "cuter": 0, "d": [0, 5], "data": 0, "date": 0, "daterang": 0, "dd": 5, "default": [0, 2, 5], "default_descript": 0, "default_host": 0, "default_path": 0, "default_port": 0, "default_titl": 0, "default_yaml_path": 0, "defin": 0, "delet": [0, 2, 3, 5], "deprec": [0, 5], "descript": [0, 5], "description_populates_with_pip": 0, "detail": 0, "dict": 0, "dictionari": 0, "die": 5, "dir": [0, 5], "direct_pruning_of_fil": 0, "directli": 3, "directori": [0, 1, 2], "disabl": [0, 2, 5], "disk": 0, "displai": 0, "do": [0, 5], "doc": 5, "docstr": 1, "document": [0, 5], "doe": 0, "doesn": 0, "doubt": 5, "due": 0, "duplic": 0, "e": 0, "each": 0, "easi": [2, 5], "eg": [2, 5], "eleph": 5, "els": 0, "empti": [0, 5], "empty_str_to_non": 0, "enable_experimental_featur": 0, "end": 5, "enhanc": [0, 5], "ensur": 0, "entri": [0, 2, 5], "environ": 0, "error": [0, 2, 5], "etc": 5, "exampl": [0, 1, 2], "exclude_unset": 0, "exist": 0, "exit": [0, 5], "exit_on_invalid_argu": 0, "experiment": 3, "explos": 0, "facebook": 5, "factori": 3, "fail_on_empty_dir": 0, "fake": 5, "fake_fil": 5, "fals": 0, "fanci": 5, "featur": 3, "feedback": 5, "field": [0, 5], "fieldinfo": 0, "file": 1, "file1": 0, "file2": 0, "file_chang": 0, "file_handl": 0, "file_path": 0, "file_path_arg": 0, "fill": 5, "final": 0, "find_duplicate_titl": 0, "finish": [0, 5], "fit": 3, "fix": [0, 5], "flag": 5, "folder": [0, 5], "follow": [0, 5], "footer": [0, 3], "footer_fil": 0, "format": [0, 5], "format_files_changed_entri": 0, "format_release_not": 0, "fortran": 5, "found": 0, "from": [0, 5], "fulli": 3, "function": [0, 3], "futur": 3, "gener": [0, 1, 2, 3], "generate_file_change_section_list_of_str": 0, "generate_section_str": 0, "genindex": 3, "get": [0, 3, 5], "get_boolean_prompt_funct": 0, "get_changed_fil": 5, "get_config_fil": 0, "get_current_git_branch": 0, "get_file_list_from_cli_input": 0, "get_git_repo_root": 0, "get_git_statu": 0, "get_header_foot": 0, "get_pars": 0, "get_project_config_file_path": 0, "get_rich_open": 0, "get_set": 0, "get_settings_from_config_fil": 0, "get_site_config_file_path": 0, "get_user_config_file_path": 0, "get_yaml_files_from_input": 0, "get_yaml_template_path": 0, "git": 0, "github": [0, 1, 5], "given": 0, "gpu": 5, "gwynu": 0, "h": 5, "had": 3, "handl": 0, "have": [2, 5], "header": [0, 3], "header_fil": 0, "help": [1, 2], "home": 0, "host_requir": 0, "hotfix": 3, "html": 3, "http": [0, 5], "i": [0, 2, 3, 5], "incorpor": 3, "increas": 0, "indent": [2, 5], "index": [0, 1, 3], "indic": 0, "inform": 5, "ini": 3, "init": [0, 5], "init_logg": 0, "initi": 5, "input": [0, 3], "input_dict": 0, "input_fil": 0, "input_files_or_fold": [0, 5], "input_fold": 0, "insensit": 0, "insert": 0, "instagram": 5, "instanc": 0, "instead": 0, "int": 0, "integr": [0, 5], "inv": 3, "invalid": [0, 2], "issu": [0, 5], "item": [0, 5], "j": [3, 5], "json_schema_extra": 0, "kei": 0, "leav": [3, 5], "left": 2, "licens": 5, "like": [2, 5], "line": [0, 5], "list": [0, 5], "local": 3, "log": 0, "logger": 0, "look": [2, 5], "made": 0, "main": [2, 3, 5], "manual": 5, "map": 0, "match": 0, "matter": 0, "max_length": 0, "md": 3, "mechan": 0, "media": 5, "merg": [0, 3], "merge_and_validate_config_fil": 0, "messag": [2, 5], "metadata": 0, "min_length": 0, "minlen": 0, "mix": 3, "mm": 5, "model": 0, "model_computed_field": 0, "model_config": 0, "model_field": 0, "modifi": [0, 2, 3, 5], "modindex": 3, "modul": 1, "more": [0, 3, 5], "mostli": 3, "move": [0, 2, 5], "multipl": 0, "must": 3, "n": 0, "name": [0, 3, 5], "namespac": 0, "nc": 5, "need": [3, 5], "nest": 0, "new": 5, "no_format": 0, "non": [2, 5], "none": 0, "nonetyp": 0, "note": [1, 2, 3], "now": 2, "nr": 5, "null": [0, 3, 5], "number": [0, 3, 5], "o": 5, "object": [0, 3], "octob": 4, "off": [3, 5], "old": [3, 5], "onc": 5, "onli": [3, 5], "open": 0, "option": [0, 5], "order": [0, 5], "organ": 3, "origin": 0, "otherwis": 0, "our": 5, "out": 5, "output": [0, 1, 3], "output_fil": [0, 5], "overrid": 0, "override_dict_with_environmental_vari": 0, "overwrit": 0, "p": 5, "page": 1, "paramet": 0, "pars": 0, "parse_argu": 0, "parse_d": 0, "parser": 0, "pass": [0, 2, 5], "past": [2, 5], "path": [0, 2, 5], "pattern": [0, 3], "per": 3, "perform": [0, 5], "pipe": 0, "place": 5, "pleas": [3, 5], "popul": [3, 5], "populate_by_nam": 0, "posit": 5, "possibl": 3, "pr": 5, "preced": 0, "predefin": 0, "prefix": 5, "prefix_fil": [0, 5], "prepend": [0, 5], "previou": [0, 5], "previous": [0, 2, 3], "print": [0, 2, 5], "print_funct": 0, "print_out_git_changed_fil": 0, "print_version_and_exit": 0, "process": 2, "program": [0, 5], "progress": 0, "project": [0, 3], "provid": [0, 3, 5], "prune": [1, 3], "prune_empti": 0, "prune_list": 0, "prune_yaml": 0, "prune_yaml_fil": 0, "pull": 0, "py": [2, 3, 5], "pydant": 0, "pydanticundefin": 0, "pyproject": 3, "pytest": 3, "pyyaml": 0, "q": 5, "question": 5, "quiet": [0, 5], "quit": 2, "r": 5, "rais": 0, "rather": 3, "read": 0, "read_config_fil": 0, "read_yaml_fil": 0, "readm": 3, "real": 5, "realli": 5, "recurs": [0, 5], "relat": [0, 5], "related_issu": 0, "relatedinternalissu": 0, "relatedissu": 0, "releas": [1, 2, 3], "release_d": [0, 5], "release_templ": 0, "release_vers": 0, "release_yaml_templ": [0, 3], "releasenot": 0, "releasetempl": 0, "remov": [0, 3, 5], "renam": 0, "replac": 0, "repo": [0, 3, 5], "repo_path": 0, "repo_url": [0, 5], "repositori": [0, 1], "request": 3, "requir": [0, 3], "respect": 0, "result": 2, "retriev": 0, "return": 0, "revert": 3, "rich": [0, 5], "rich_open": 0, "root": 0, "rootmodel": 0, "rootmodelroottyp": 0, "rst": [0, 3, 5], "run": [2, 3, 5], "run_from_cli": 0, "sai": 2, "same": 0, "schema": 0, "search": [1, 5], "searchindex": 3, "section": [2, 5], "section_lin": 0, "see": [0, 5], "set": [3, 5], "settings_manag": 0, "settings_templ": 0, "settingstempl": 0, "setup_consol": 0, "setup_messag": 0, "should": [0, 3], "show": 5, "silent": 3, "site": 0, "so": 3, "social": 5, "softwar": 5, "some": 3, "sort": 5, "sourc": [0, 3], "special": 0, "specif": 0, "specifi": [0, 2, 3], "sphinx": [0, 3], "src": [2, 3], "standard": 0, "start": [0, 5], "statu": 0, "str": 0, "strai": 2, "stream": 0, "string": [0, 3], "strip_whitespac": 0, "structur": 0, "suffix": [0, 5], "suffix_fil": [0, 5], "suggest": 3, "summari": 0, "support": 5, "suppress": 0, "symbol": 0, "system": 5, "systemexit": 0, "t": [0, 3, 5], "team": 5, "temporari": 2, "test": [2, 5], "test2": [2, 3, 5], "test3": [2, 5], "test4": [2, 5], "test_integ": 3, "text": 5, "than": 3, "thank": 5, "thei": 3, "them": 0, "thi": [0, 2, 3, 4, 5], "those": 2, "thought": 5, "time": 5, "titl": [0, 5], "todai": [0, 5], "toml": 3, "track": 5, "tri": 3, "true": 0, "turn": 5, "twitter": 5, "txt": 5, "type": 0, "u": 5, "union": 0, "unknown": 5, "unus": 0, "up": [0, 3], "updat": [0, 5], "url": [0, 3], "urlconstraint": 0, "us": [0, 1, 3], "usag": [1, 3], "use_color": 0, "use_rich": 0, "user": [0, 5], "usual": 0, "util": 3, "v1": [0, 3, 5], "valid": [0, 3], "valid_chang": 0, "valid_field": 0, "validate_default": 0, "validationerror": 0, "valu": 0, "value_error_on_invalid_yaml": 0, "valueerror": 0, "variabl": 0, "verifi": 2, "version": [0, 1], "via": 0, "visit": 5, "wa": [0, 2, 3, 5], "wai": 0, "want": 0, "warn": 3, "we": 5, "websit": 5, "were": 3, "what": 5, "when": [0, 2, 3, 5], "where": [0, 3, 5], "whether": 0, "which": [0, 5], "within": 0, "without": [0, 3], "work": [0, 2, 3, 5], "working_dir": 0, "would": [2, 3, 5], "wouldn": 3, "write": [0, 5], "write_output_fil": 0, "write_yaml_templ": 5, "written": [0, 2, 3], "www": 5, "y": 0, "yaml": [1, 2], "yaml_dir": 5, "yaml_file_path": 0, "yd": 5, "yet": 3, "yml": 5, "you": [0, 5], "your": [2, 5], "yyyi": 5, "z": 0, "za": 0}, "titles": ["API", "Welcome to brassy\u2019s documentation!", "Version 0.0.2 (2024-08-09)", "Version 0.0.3 (October 23, 2024)", "Release Notes", "Using Brassy"], "titleterms": {"": 1, "0": [2, 3, 4], "08": 2, "09": 2, "1": 4, "2": [2, 4], "2024": [2, 3], "23": 3, "3": [3, 4], "action": 0, "ad": [2, 3, 5], "add": [2, 3], "allow": 3, "api": 0, "being": 2, "blank": 3, "brassi": [1, 5], "bug": [2, 3], "build": [0, 2, 3], "chang": [2, 3, 5], "cli": [0, 5], "code": 0, "config": 3, "consol": 2, "continu": 3, "control": 5, "creat": 5, "date": [3, 5], "default": 3, "descript": 3, "directori": 5, "disabl": 3, "doc": 3, "docstr": 0, "document": [1, 3], "either": 3, "empti": [2, 3], "enabl": 2, "enhanc": [2, 3], "entri": 3, "error": 3, "exampl": [3, 5], "field": 3, "file": [0, 2, 3, 5], "finish": 3, "fix": [2, 3], "footer": 5, "from": 2, "gener": 5, "get": 2, "git": 5, "git_handl": 0, "handler": 0, "have": 3, "header": 5, "help": 5, "implement": 3, "indic": 1, "init": 3, "initi": 0, "integr": 3, "intern": 3, "issu": 3, "line": 2, "main": 0, "make": 3, "manag": 0, "messag": 0, "miss": 3, "modul": 0, "new": 3, "note": [0, 4, 5], "now": 3, "octob": 3, "option": 3, "out": 3, "output": [2, 5], "path": 3, "pipe": 3, "pretti": 3, "print": 3, "prune": [0, 5], "put": 3, "quiet": 2, "relat": 3, "releas": [0, 4, 5], "remov": 2, "render": 3, "section": 3, "set": 0, "specifi": 5, "start": 3, "tabl": 1, "templat": [0, 3, 5], "test": 3, "titl": 3, "top": 3, "updat": 3, "us": 5, "usag": 5, "user": 3, "util": 0, "version": [2, 3, 4, 5], "via": 5, "welcom": 1, "without": 2, "write": [2, 3], "yaml": [0, 3, 5]}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API": [[0, null]], "Actions": [[0, "actions"]], "Add integration tests": [[3, "add-integration-tests"]], "Add internal option to related issue": [[3, "add-internal-option-to-related-issue"]], "Add start and finish dates for changes": [[3, "add-start-and-finish-dates-for-changes"]], "Add \u2013get-changed-files": [[2, "add-get-changed-files"]], "Add \u2013init that writes out config files": [[3, "add-init-that-writes-out-config-files"]], "Added new templating integration test": [[3, "added-new-templating-integration-test"]], "Added \u2013output-to-console": [[2, "added-output-to-console"]], "Adding Headers and/or Footers": [[5, "adding-headers-and-or-footers"]], "Allow entries to have no field and no title": [[3, "allow-entries-to-have-no-field-and-no-title"]], "Allow users to disable pipe on description field": [[3, "allow-users-to-disable-pipe-on-description-field"]], "Bug fix": [[2, "bug-fix"], [3, "bug-fix"], [3, "id6"], [3, "id7"], [3, "id8"], [3, "id9"], [3, "id10"]], "Build Release Notes": [[0, "module-brassy.actions.build_release_notes"]], "Builds now have sections with either a missing title or description": [[3, "builds-now-have-sections-with-either-a-missing-title-or-description"]], "CLI": [[0, "module-brassy.utils.CLI"]], "Change YAML directory": [[5, "change-yaml-directory"]], "Code Docstrings": [[0, "code-docstrings"]], "Continuous integration": [[3, "continuous-integration"], [3, "id12"]], "Controlling CLI Output": [[5, "controlling-cli-output"]], "Create YAML template": [[5, "create-yaml-template"]], "Documentation": [[3, "documentation"], [3, "id11"]], "Documentation updated for new version": [[3, "documentation-updated-for-new-version"]], "Empty file change lines removed from output": [[2, "empty-file-change-lines-removed-from-output"]], "Enable building without writing to file": [[2, "enable-building-without-writing-to-file"]], "Enhancement": [[2, "enhancement"], [3, "enhancement"], [3, "id1"], [3, "id2"], [3, "id3"], [3, "id4"], [3, "id5"]], "Example usage": [[5, "example-usage"]], "File Handler": [[0, "module-brassy.utils.file_handler"]], "Fix bug with \u2013write-template-error": [[3, "fix-bug-with-write-template-error"]], "Fix docs rendering of examples.": [[3, "fix-docs-rendering-of-examples"]], "Fix empty \u201c\u2013write-yaml-template bug": [[3, "fix-empty-write-yaml-template-bug"]], "Fixed quiet not being quiet.": [[2, "fixed-quiet-not-being-quiet"]], "Generate release notes": [[5, "generate-release-notes"]], "Generating the changed files via git": [[5, "generating-the-changed-files-via-git"]], "Help!": [[5, "help"]], "Implement default path": [[3, "implement-default-path"]], "Indices and tables": [[1, "indices-and-tables"]], "Initialize": [[0, "module-brassy.actions.init"]], "Main Module": [[0, "module-brassy.brassy"]], "Make optional dates optional": [[3, "make-optional-dates-optional"]], "Messages": [[0, "module-brassy.utils.messages"]], "Print pretty error on blank yaml.": [[3, "print-pretty-error-on-blank-yaml"]], "Prune YAML": [[0, "module-brassy.actions.prune_yaml"]], "Prune YAML file": [[5, "prune-yaml-file"]], "Put title at top of template": [[3, "put-title-at-top-of-template"]], "Related Issue": [[5, "related-issue"]], "Release Notes": [[4, null]], "Release YAML": [[0, "module-brassy.templates.release_yaml_template"]], "Settings": [[0, "module-brassy.templates.settings_template"]], "Settings Manager": [[0, "module-brassy.utils.settings_manager"]], "Specifying Date": [[5, "specifying-date"]], "Specifying Version": [[5, "specifying-version"]], "Support for Internal Repos": [[5, "support-for-internal-repos"]], "Templates": [[0, "templates"]], "Using Brassy": [[5, null]], "Utils": [[0, "utils"]], "Version 0.0.1": [[4, "version-0-0-1"]], "Version 0.0.2": [[4, "version-0-0-2"]], "Version 0.0.2 (2024-08-09)": [[2, null]], "Version 0.0.3": [[4, "version-0-0-3"]], "Version 0.0.3 (October 23, 2024)": [[3, null]], "Welcome to brassy\u2019s documentation!": [[1, null]], "git_handler": [[0, "module-brassy.utils.git_handler"]]}, "docnames": ["api", "index", "releases/0.0.2", "releases/0.0.3", "releases/index", "using-brassy"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst", "releases/0.0.2.rst", "releases/0.0.3.rst", "releases/index.rst", "using-brassy.rst"], "indexentries": {"added (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.added", false]], "blank_string() (brassy.templates.release_yaml_template.relatedissue method)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.blank_string", false]], "brassy.actions.build_release_notes": [[0, "module-brassy.actions.build_release_notes", false]], "brassy.actions.init": [[0, "module-brassy.actions.init", false]], "brassy.actions.prune_yaml": [[0, "module-brassy.actions.prune_yaml", false]], "brassy.brassy": [[0, "module-brassy.brassy", false]], "brassy.templates.release_yaml_template": [[0, "module-brassy.templates.release_yaml_template", false]], "brassy.templates.settings_template": [[0, "module-brassy.templates.settings_template", false]], "brassy.utils.cli": [[0, "module-brassy.utils.CLI", false]], "brassy.utils.file_handler": [[0, "module-brassy.utils.file_handler", false]], "brassy.utils.git_handler": [[0, "module-brassy.utils.git_handler", false]], "brassy.utils.messages": [[0, "module-brassy.utils.messages", false]], "brassy.utils.settings_manager": [[0, "module-brassy.utils.settings_manager", false]], "build_release_notes() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.build_release_notes", false]], "change_categories (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.change_categories", false]], "changeitem (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.ChangeItem", false]], "check_at_least_one_field() (brassy.templates.release_yaml_template.files method)": [[0, "brassy.templates.release_yaml_template.Files.check_at_least_one_field", false]], "create_blank_template_yaml_file() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.create_blank_template_yaml_file", false]], "create_config_file() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.create_config_file", false]], "date (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.date", false]], "daterange (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.DateRange", false]], "default_description (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_description", false]], "default_title (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_title", false]], "default_yaml_path (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.default_yaml_path", false]], "deleted (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.deleted", false]], "description (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.description", false]], "description_populates_with_pipe (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.description_populates_with_pipe", false]], "direct_pruning_of_files() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.direct_pruning_of_files", false]], "empty_str_to_none() (brassy.templates.release_yaml_template.changeitem method)": [[0, "brassy.templates.release_yaml_template.ChangeItem.empty_str_to_none", false]], "enable_experimental_features (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.enable_experimental_features", false]], "exit_on_invalid_arguments() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.exit_on_invalid_arguments", false]], "fail_on_empty_dir (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.fail_on_empty_dir", false]], "files (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.files", false]], "files (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.Files", false]], "find_duplicate_titles() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.find_duplicate_titles", false]], "finish (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.finish", false]], "format_files_changed_entry() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.format_files_changed_entry", false]], "format_release_notes() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.format_release_notes", false]], "generate_file_change_section_list_of_strings() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.generate_file_change_section_list_of_strings", false]], "generate_section_string() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.generate_section_string", false]], "get_boolean_prompt_function() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.get_boolean_prompt_function", false]], "get_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_config_files", false]], "get_current_git_branch() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.get_current_git_branch", false]], "get_file_list_from_cli_input() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_file_list_from_cli_input", false]], "get_git_repo_root() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_git_repo_root", false]], "get_git_status() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.get_git_status", false]], "get_header_footer() (in module brassy.actions.build_release_notes)": [[0, "brassy.actions.build_release_notes.get_header_footer", false]], "get_parser() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_parser", false]], "get_project_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_project_config_file_path", false]], "get_rich_opener() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.get_rich_opener", false]], "get_settings() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_settings", false]], "get_settings_from_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_settings_from_config_files", false]], "get_site_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_site_config_file_path", false]], "get_user_config_file_path() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.get_user_config_file_path", false]], "get_yaml_files_from_input() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.get_yaml_files_from_input", false]], "get_yaml_template_path() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.get_yaml_template_path", false]], "init() (in module brassy.actions.init)": [[0, "brassy.actions.init.init", false]], "init_logger() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.init_logger", false]], "internal (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.internal", false]], "merge_and_validate_config_files() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.merge_and_validate_config_files", false]], "model_computed_fields (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_computed_fields", false]], "model_computed_fields (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_computed_fields", false]], "model_computed_fields (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_computed_fields", false]], "model_computed_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_computed_fields", false]], "model_config (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_config", false]], "model_config (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_config", false]], "model_config (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_config", false]], "model_config (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_config", false]], "model_config (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_config", false]], "model_config (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_config", false]], "model_config (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_config", false]], "model_config (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_config", false]], "model_fields (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.relatedinternalissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.model_fields", false]], "model_fields (brassy.templates.release_yaml_template.releasenote attribute)": [[0, "brassy.templates.release_yaml_template.ReleaseNote.model_fields", false]], "model_fields (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.model_fields", false]], "model_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.model_fields", false]], "modified (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.modified", false]], "module": [[0, "module-brassy.actions.build_release_notes", false], [0, "module-brassy.actions.init", false], [0, "module-brassy.actions.prune_yaml", false], [0, "module-brassy.brassy", false], [0, "module-brassy.templates.release_yaml_template", false], [0, "module-brassy.templates.settings_template", false], [0, "module-brassy.utils.CLI", false], [0, "module-brassy.utils.file_handler", false], [0, "module-brassy.utils.git_handler", false], [0, "module-brassy.utils.messages", false], [0, "module-brassy.utils.settings_manager", false]], "moved (brassy.templates.release_yaml_template.files attribute)": [[0, "brassy.templates.release_yaml_template.Files.moved", false]], "number (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.number", false]], "override_dict_with_environmental_variables() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.override_dict_with_environmental_variables", false]], "parse_arguments() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.parse_arguments", false]], "parse_date() (brassy.templates.release_yaml_template.daterange class method)": [[0, "brassy.templates.release_yaml_template.DateRange.parse_date", false]], "populate_by_name (brassy.templates.settings_template.releasetemplate.config attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.Config.populate_by_name", false]], "print_out_git_changed_files() (in module brassy.utils.git_handler)": [[0, "brassy.utils.git_handler.print_out_git_changed_files", false]], "print_version_and_exit() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.print_version_and_exit", false]], "prune_empty() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.prune_empty", false]], "prune_yaml_file() (in module brassy.actions.prune_yaml)": [[0, "brassy.actions.prune_yaml.prune_yaml_file", false]], "read_config_file() (in module brassy.utils.settings_manager)": [[0, "brassy.utils.settings_manager.read_config_file", false]], "read_yaml_files() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.read_yaml_files", false]], "related_issue (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.related_issue", false]], "relatedinternalissue (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.RelatedInternalIssue", false]], "relatedissue (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.RelatedIssue", false]], "release_template (brassy.templates.settings_template.releasetemplate attribute)": [[0, "brassy.templates.settings_template.ReleaseTemplate.release_template", false]], "releasenote (class in brassy.templates.release_yaml_template)": [[0, "brassy.templates.release_yaml_template.ReleaseNote", false]], "releasetemplate (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.ReleaseTemplate", false]], "releasetemplate.config (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.ReleaseTemplate.Config", false]], "repo_url (brassy.templates.release_yaml_template.relatedissue attribute)": [[0, "brassy.templates.release_yaml_template.RelatedIssue.repo_url", false]], "run_from_cli() (in module brassy.brassy)": [[0, "brassy.brassy.run_from_CLI", false]], "run_from_cli() (in module brassy.utils.cli)": [[0, "brassy.utils.CLI.run_from_CLI", false]], "settingstemplate (class in brassy.templates.settings_template)": [[0, "brassy.templates.settings_template.SettingsTemplate", false]], "setup_console() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.setup_console", false]], "setup_messages() (in module brassy.utils.messages)": [[0, "brassy.utils.messages.setup_messages", false]], "start (brassy.templates.release_yaml_template.daterange attribute)": [[0, "brassy.templates.release_yaml_template.DateRange.start", false]], "templates (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.templates", false]], "title (brassy.templates.release_yaml_template.changeitem attribute)": [[0, "brassy.templates.release_yaml_template.ChangeItem.title", false]], "use_color (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.use_color", false]], "valid_changes (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.valid_changes", false]], "valid_fields (brassy.templates.settings_template.settingstemplate attribute)": [[0, "brassy.templates.settings_template.SettingsTemplate.valid_fields", false]], "value_error_on_invalid_yaml() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.value_error_on_invalid_yaml", false]], "write_output_file() (in module brassy.utils.file_handler)": [[0, "brassy.utils.file_handler.write_output_file", false]]}, "objects": {"brassy": [[0, 0, 0, "-", "brassy"]], "brassy.actions": [[0, 0, 0, "-", "build_release_notes"], [0, 0, 0, "-", "init"], [0, 0, 0, "-", "prune_yaml"]], "brassy.actions.build_release_notes": [[0, 1, 1, "", "build_release_notes"], [0, 1, 1, "", "find_duplicate_titles"], [0, 1, 1, "", "format_files_changed_entry"], [0, 1, 1, "", "format_release_notes"], [0, 1, 1, "", "generate_file_change_section_list_of_strings"], [0, 1, 1, "", "generate_section_string"], [0, 1, 1, "", "get_header_footer"]], "brassy.actions.init": [[0, 1, 1, "", "init"]], "brassy.actions.prune_yaml": [[0, 1, 1, "", "direct_pruning_of_files"], [0, 1, 1, "", "prune_empty"], [0, 1, 1, "", "prune_yaml_file"]], "brassy.brassy": [[0, 1, 1, "", "run_from_CLI"]], "brassy.templates": [[0, 0, 0, "-", "release_yaml_template"], [0, 0, 0, "-", "settings_template"]], "brassy.templates.release_yaml_template": [[0, 2, 1, "", "ChangeItem"], [0, 2, 1, "", "DateRange"], [0, 2, 1, "", "Files"], [0, 2, 1, "", "RelatedInternalIssue"], [0, 2, 1, "", "RelatedIssue"], [0, 2, 1, "", "ReleaseNote"]], "brassy.templates.release_yaml_template.ChangeItem": [[0, 3, 1, "", "date"], [0, 3, 1, "", "description"], [0, 4, 1, "", "empty_str_to_none"], [0, 3, 1, "", "files"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "related_issue"], [0, 3, 1, "", "title"]], "brassy.templates.release_yaml_template.DateRange": [[0, 3, 1, "", "finish"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 4, 1, "", "parse_date"], [0, 3, 1, "", "start"]], "brassy.templates.release_yaml_template.Files": [[0, 3, 1, "", "added"], [0, 4, 1, "", "check_at_least_one_field"], [0, 3, 1, "", "deleted"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "modified"], [0, 3, 1, "", "moved"]], "brassy.templates.release_yaml_template.RelatedInternalIssue": [[0, 3, 1, "", "internal"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"]], "brassy.templates.release_yaml_template.RelatedIssue": [[0, 4, 1, "", "blank_string"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "number"], [0, 3, 1, "", "repo_url"]], "brassy.templates.release_yaml_template.ReleaseNote": [[0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"]], "brassy.templates.settings_template": [[0, 2, 1, "", "ReleaseTemplate"], [0, 2, 1, "", "SettingsTemplate"]], "brassy.templates.settings_template.ReleaseTemplate": [[0, 2, 1, "", "Config"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "release_template"]], "brassy.templates.settings_template.ReleaseTemplate.Config": [[0, 3, 1, "", "populate_by_name"]], "brassy.templates.settings_template.SettingsTemplate": [[0, 3, 1, "", "change_categories"], [0, 3, 1, "", "default_description"], [0, 3, 1, "", "default_title"], [0, 3, 1, "", "default_yaml_path"], [0, 3, 1, "", "description_populates_with_pipe"], [0, 3, 1, "", "enable_experimental_features"], [0, 3, 1, "", "fail_on_empty_dir"], [0, 3, 1, "", "model_computed_fields"], [0, 3, 1, "", "model_config"], [0, 3, 1, "", "model_fields"], [0, 3, 1, "", "templates"], [0, 3, 1, "", "use_color"], [0, 3, 1, "", "valid_changes"], [0, 3, 1, "", "valid_fields"]], "brassy.utils": [[0, 0, 0, "-", "CLI"], [0, 0, 0, "-", "file_handler"], [0, 0, 0, "-", "git_handler"], [0, 0, 0, "-", "messages"], [0, 0, 0, "-", "settings_manager"]], "brassy.utils.CLI": [[0, 1, 1, "", "exit_on_invalid_arguments"], [0, 1, 1, "", "get_file_list_from_cli_input"], [0, 1, 1, "", "get_parser"], [0, 1, 1, "", "get_yaml_files_from_input"], [0, 1, 1, "", "parse_arguments"], [0, 1, 1, "", "print_version_and_exit"], [0, 1, 1, "", "run_from_CLI"]], "brassy.utils.file_handler": [[0, 1, 1, "", "create_blank_template_yaml_file"], [0, 1, 1, "", "get_yaml_template_path"], [0, 1, 1, "", "read_yaml_files"], [0, 1, 1, "", "value_error_on_invalid_yaml"], [0, 1, 1, "", "write_output_file"]], "brassy.utils.git_handler": [[0, 1, 1, "", "get_current_git_branch"], [0, 1, 1, "", "get_git_status"], [0, 1, 1, "", "print_out_git_changed_files"]], "brassy.utils.messages": [[0, 1, 1, "", "get_boolean_prompt_function"], [0, 1, 1, "", "get_rich_opener"], [0, 1, 1, "", "init_logger"], [0, 1, 1, "", "setup_console"], [0, 1, 1, "", "setup_messages"]], "brassy.utils.settings_manager": [[0, 1, 1, "", "create_config_file"], [0, 1, 1, "", "get_config_files"], [0, 1, 1, "", "get_git_repo_root"], [0, 1, 1, "", "get_project_config_file_path"], [0, 1, 1, "", "get_settings"], [0, 1, 1, "", "get_settings_from_config_files"], [0, 1, 1, "", "get_site_config_file_path"], [0, 1, 1, "", "get_user_config_file_path"], [0, 1, 1, "", "merge_and_validate_config_files"], [0, 1, 1, "", "override_dict_with_environmental_variables"], [0, 1, 1, "", "read_config_file"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [0, 5], "0": [0, 1, 5], "02": 5, "08": 4, "09": 4, "1": [0, 1, 5], "10": 5, "100000": 5, "1938": 5, "1999": 5, "2": [0, 1], "2024": [4, 5], "2026": 5, "2083": 0, "21": 5, "22": 5, "23": 4, "3": 1, "30": 5, "3000": 5, "575": 3, "822": 0, "999": 5, "A": [0, 3, 5], "By": 5, "For": [0, 2, 5], "If": [0, 5], "In": [2, 5], "It": [0, 2, 5], "NO": 0, "NOT": 3, "No": [3, 4], "Not": 3, "OR": [3, 5], "Or": 5, "The": [0, 3, 5], "To": 5, "__fields__": 0, "__init__": 3, "_pydanticgeneralmetadata": 0, "about": 0, "absolut": 0, "accept": [2, 5], "access": 3, "action": 3, "ad": 0, "add": [0, 5], "address": 0, "after": 5, "against": 5, "aka": 5, "alia": 0, "alias_prior": 0, "all": [0, 5], "allowed_schem": 0, "also": [0, 5], "alwai": 5, "am": 5, "an": [0, 2, 3, 5], "ani": [0, 5], "annoi": 5, "annot": 0, "api": [1, 3], "app_nam": 0, "append": 5, "appli": 0, "applic": 0, "appreci": 5, "appropri": 0, "ar": [0, 2, 3, 5], "aren": 5, "arg": 0, "argpars": 0, "argument": [0, 2, 3, 5], "argumentpars": 0, "assist": 5, "associ": 0, "avail": [0, 5], "b": 0, "back": 0, "backward": 3, "bar": 0, "barebon": 3, "base": 0, "basemodel": 0, "basic": 3, "becaus": [2, 3], "becom": 5, "been": [0, 2, 3, 5], "behaviour": 3, "being": 0, "blank": [0, 2, 5], "blank_str": 0, "bold": 5, "bool": 0, "branch": [0, 2, 5], "brassi": [0, 2, 3], "break": 3, "bug": [0, 5], "build_release_not": [0, 3], "built": 3, "burger": 3, "c": [0, 5], "can": [0, 3, 5], "cannot": 3, "card": 5, "case": [0, 5], "cat": 0, "categor": 0, "categori": 0, "caus": 3, "chang": [0, 1], "change_categori": 0, "change_typ": 0, "changeitem": 0, "changelog_entri": 0, "charact": 0, "check": [0, 3, 5], "check_at_least_one_field": 0, "ci": 3, "class": [0, 3], "classmethod": 0, "classvar": 0, "cli": [1, 3], "code": [1, 5], "codebas": 3, "collect": 0, "color": 5, "com": [0, 5], "combo": 3, "command": [0, 5], "compar": [2, 5], "compat": [0, 3], "comput": 0, "computedfieldinfo": 0, "config": [0, 5], "config1": 0, "config2": 0, "config_fil": 0, "configdict": 0, "configur": [0, 5], "conform": 0, "consid": [0, 5], "consol": [0, 5], "contact": 5, "contain": [0, 5], "content": [0, 3], "continu": [0, 5], "control": 1, "copi": [2, 5], "correct": 0, "correspond": 0, "cpp": 5, "crash": 5, "creat": [0, 3], "create_blank_template_yaml_fil": 0, "create_config_fil": 0, "create_file_if_not_exist": 0, "current": [0, 2, 5], "cute": 0, "cuter": 0, "d": [0, 5], "data": 0, "date": 0, "daterang": 0, "dd": 5, "default": [0, 2, 5], "default_descript": 0, "default_host": 0, "default_path": 0, "default_port": 0, "default_titl": 0, "default_yaml_path": 0, "defin": 0, "delet": [0, 2, 3, 5], "deprec": [0, 5], "descript": [0, 5], "description_populates_with_pip": 0, "detail": 0, "dict": 0, "dictionari": 0, "die": 5, "dir": [0, 5], "direct_pruning_of_fil": 0, "directli": 3, "directori": [0, 1, 2], "disabl": [0, 2, 5], "disk": 0, "displai": 0, "do": [0, 5], "doc": 5, "docstr": 1, "document": [0, 5], "doe": 0, "doesn": 0, "done": 5, "doubt": 5, "due": 0, "duplic": 0, "e": 0, "each": 0, "easi": [2, 5], "eg": [2, 5], "eleph": 5, "els": 0, "empti": [0, 5], "empty_str_to_non": 0, "enable_experimental_featur": 0, "end": 5, "enhanc": [0, 5], "ensur": 0, "entri": [0, 2, 5], "environ": 0, "error": [0, 2, 5], "etc": 5, "everyth": 5, "exampl": [0, 1, 2], "exclude_unset": 0, "exist": 0, "exit": [0, 5], "exit_on_invalid_argu": 0, "experiment": 3, "explos": 0, "facebook": 5, "factori": 3, "fail_on_empty_dir": 0, "fake": 5, "fake_fil": 5, "fals": 0, "fanci": 5, "featur": 3, "feedback": 5, "field": [0, 5], "fieldinfo": 0, "file": 1, "file1": 0, "file2": 0, "file_chang": 0, "file_handl": 0, "file_path": 0, "file_path_arg": 0, "fill": 5, "final": 0, "find_duplicate_titl": 0, "finish": [0, 5], "fit": 3, "fix": [0, 5], "flag": 5, "folder": [0, 5], "follow": [0, 5], "footer": [0, 3], "footer_fil": 0, "format": [0, 5], "format_files_changed_entri": 0, "format_release_not": 0, "fortran": 5, "found": 0, "from": [0, 5], "fulli": 3, "function": [0, 3], "futur": 3, "gener": [0, 1, 2, 3], "generate_file_change_section_list_of_str": 0, "generate_section_str": 0, "genindex": 3, "get": [0, 3, 5], "get_boolean_prompt_funct": 0, "get_changed_fil": 5, "get_config_fil": 0, "get_current_git_branch": 0, "get_file_list_from_cli_input": 0, "get_git_repo_root": 0, "get_git_statu": 0, "get_header_foot": 0, "get_pars": 0, "get_project_config_file_path": 0, "get_rich_open": 0, "get_set": 0, "get_settings_from_config_fil": 0, "get_site_config_file_path": 0, "get_user_config_file_path": 0, "get_yaml_files_from_input": 0, "get_yaml_template_path": 0, "git": 0, "github": [0, 1, 5], "given": 0, "gpu": 5, "h": 5, "had": 3, "handl": 0, "have": [0, 2, 5], "header": [0, 3], "header_fil": 0, "help": [1, 2], "home": 0, "host_requir": 0, "hotfix": 3, "html": 3, "http": [0, 5], "i": [0, 2, 3, 5], "includ": 5, "incorpor": 3, "increas": 0, "indent": [2, 5], "index": [0, 1, 3], "indic": 0, "info": 5, "inform": 5, "ini": 3, "init": [0, 5], "init_logg": 0, "initi": 5, "input": [0, 3], "input_dict": 0, "input_fil": 0, "input_files_or_fold": [0, 5], "input_fold": 0, "insensit": 0, "insert": 0, "instagram": 5, "instanc": 0, "instead": 0, "int": 0, "integr": [0, 5], "intern": 0, "inv": 3, "invalid": [0, 2], "isn": 5, "issu": [0, 1], "item": [0, 5], "j": [3, 5], "json_schema_extra": 0, "just": 5, "kei": 0, "laptop": 5, "leav": [3, 5], "left": 2, "licens": 5, "like": [2, 5], "line": [0, 5], "link": 5, "linux": 5, "list": [0, 5], "local": 3, "log": 0, "logger": 0, "look": [2, 5], "made": 0, "main": [2, 3, 5], "manual": 5, "map": 0, "matter": 0, "max_length": 0, "md": 3, "mechan": 0, "media": 5, "merg": [0, 3], "merge_and_validate_config_fil": 0, "messag": [2, 5], "metadata": 0, "might": 5, "min_length": 0, "minlen": 0, "mix": 3, "mm": 5, "model": 0, "model_computed_field": 0, "model_config": 0, "model_field": 0, "modifi": [0, 2, 3, 5], "modindex": 3, "modul": 1, "more": [0, 3, 5], "mostli": 3, "move": [0, 2, 5], "multipl": 0, "must": [3, 5], "n": 0, "name": [0, 3, 5], "namespac": 0, "nc": 5, "need": [3, 5], "nest": 0, "new": 5, "no_format": 0, "non": [2, 5], "none": 0, "nonetyp": 0, "note": [1, 2, 3], "now": 2, "nr": 5, "null": [0, 3, 5], "number": [0, 3, 5], "o": 5, "object": [0, 3], "octob": 4, "off": [3, 5], "old": [3, 5], "onc": 5, "onli": [3, 5], "open": 0, "option": [0, 5], "order": [0, 5], "organ": 3, "origin": 0, "other": 5, "otherwis": 0, "our": 5, "out": 5, "output": [0, 1, 3], "output_fil": [0, 5], "overrid": 0, "override_dict_with_environmental_vari": 0, "overwrit": 0, "p": 5, "page": 1, "paramet": 0, "pars": 0, "parse_argu": 0, "parse_d": 0, "parser": 0, "pass": [0, 2, 5], "past": [2, 5], "path": [0, 2, 5], "pattern": [0, 3, 5], "per": 3, "perform": [0, 5], "person": 5, "pipe": 0, "place": 5, "pleas": [3, 5], "popul": [3, 5], "populate_by_nam": 0, "posit": 5, "possibl": 3, "pr": 5, "preced": 0, "predefin": 0, "prefix": 5, "prefix_fil": [0, 5], "prepend": [0, 5], "previou": [0, 5], "previous": [0, 2, 3], "print": [0, 2, 5], "print_funct": 0, "print_out_git_changed_fil": 0, "print_version_and_exit": 0, "process": 2, "program": [0, 5], "progress": 0, "project": [0, 3], "provid": [0, 3, 5], "prune": [1, 3], "prune_empti": 0, "prune_list": 0, "prune_yaml": 0, "prune_yaml_fil": 0, "pull": 0, "push": 5, "py": [2, 3, 5], "pydant": 0, "pydanticundefin": 0, "pyproject": 3, "pytest": 3, "pyyaml": 0, "q": 5, "question": 5, "quiet": [0, 5], "quit": 2, "r": 5, "rais": 0, "rather": 3, "read": 0, "read_config_fil": 0, "read_yaml_fil": 0, "readm": 3, "real": 5, "realli": 5, "recurs": [0, 5], "relat": [0, 1], "related_issu": 0, "relatedinternalissu": 0, "relatedissu": 0, "releas": [1, 2, 3], "release_d": [0, 5], "release_templ": 0, "release_vers": 0, "release_yaml_templ": [0, 3], "releasenot": 0, "releasetempl": 0, "remov": [0, 3, 5], "renam": 0, "render": 5, "replac": 0, "repo": [0, 3], "repo_path": 0, "repo_url": [0, 5], "repositori": [0, 1, 5], "request": 3, "requir": [0, 3], "result": 2, "retriev": 0, "return": 0, "revert": 3, "rich": [0, 5], "rich_open": 0, "root": 0, "rootmodel": 0, "rootmodelroottyp": 0, "rst": [0, 3, 5], "run": [2, 3, 5], "run_from_cli": 0, "sai": 2, "same": 0, "schema": 0, "search": [1, 5], "searchindex": 3, "section": [2, 5], "section_lin": 0, "see": [0, 5], "server": 5, "set": [3, 5], "settings_manag": 0, "settings_templ": 0, "settingstempl": 0, "setup_consol": 0, "setup_messag": 0, "share": 5, "should": [0, 3], "show": 5, "silent": 3, "site": 0, "so": 3, "social": 5, "softwar": 5, "some": [3, 5], "someth": 5, "sort": 5, "sourc": [0, 3], "special": 0, "specif": 0, "specifi": [0, 2, 3], "sphinx": [0, 3], "src": [2, 3], "standard": 0, "start": [0, 5], "statu": 0, "str": 0, "strai": 2, "stream": 0, "string": [0, 3, 5], "strip_whitespac": 0, "structur": 0, "suffix": [0, 5], "suffix_fil": [0, 5], "suggest": 3, "summari": 0, "suppress": 0, "symbol": 0, "system": 5, "systemexit": 0, "t": [0, 3, 5], "task": 5, "team": 5, "temporari": 2, "test": [2, 5], "test2": [2, 3, 5], "test3": [2, 5], "test4": [2, 5], "test_integ": 3, "text": 5, "than": 3, "thank": 5, "thei": [3, 5], "them": 0, "thi": [0, 2, 3, 4, 5], "those": 2, "thought": 5, "time": 5, "titl": [0, 5], "todai": [0, 5], "toml": 3, "torvald": 5, "track": 5, "tri": 3, "true": 0, "turn": 5, "twitter": 5, "txt": 5, "type": 0, "u": 5, "union": 0, "unknown": 5, "unus": 0, "up": [0, 3], "updat": [0, 5], "upon": 5, "url": [0, 3, 5], "urlconstraint": 0, "us": [0, 1, 3], "usag": [1, 3], "use_color": 0, "use_rich": 0, "user": [0, 5], "usual": 0, "util": 3, "v1": [0, 3, 5], "valid": [0, 3], "valid_chang": 0, "valid_field": 0, "validate_default": 0, "validationerror": 0, "valu": 0, "value_error_on_invalid_yaml": 0, "valueerror": 0, "variabl": 0, "verifi": 2, "version": [0, 1], "via": 0, "visit": 5, "wa": [0, 2, 3, 5], "wai": 0, "want": 0, "warn": 3, "we": 5, "websit": 5, "were": 3, "what": 5, "when": [0, 2, 3, 5], "where": [0, 3, 5], "whether": 0, "which": [0, 5], "within": 0, "without": [0, 3, 5], "work": [0, 2, 3, 5], "working_dir": 0, "workspac": 0, "would": [2, 3, 5], "wouldn": 3, "write": [0, 5], "write_output_fil": 0, "write_yaml_templ": 5, "written": [0, 2, 3], "www": 5, "y": 0, "yaml": [1, 2], "yaml_dir": 5, "yaml_file_path": 0, "yd": 5, "yet": 3, "yml": 5, "you": [0, 5], "your": [2, 5], "yyyi": 5, "z": 0, "za": 0}, "titles": ["API", "Welcome to brassy\u2019s documentation!", "Version 0.0.2 (2024-08-09)", "Version 0.0.3 (October 23, 2024)", "Release Notes", "Using Brassy"], "titleterms": {"": 1, "0": [2, 3, 4], "08": 2, "09": 2, "1": 4, "2": [2, 4], "2024": [2, 3], "23": 3, "3": [3, 4], "action": 0, "ad": [2, 3, 5], "add": [2, 3], "allow": 3, "api": 0, "being": 2, "blank": 3, "brassi": [1, 5], "bug": [2, 3], "build": [0, 2, 3], "chang": [2, 3, 5], "cli": [0, 5], "code": 0, "config": 3, "consol": 2, "continu": 3, "control": 5, "creat": 5, "date": [3, 5], "default": 3, "descript": 3, "directori": 5, "disabl": 3, "doc": 3, "docstr": 0, "document": [1, 3], "either": 3, "empti": [2, 3], "enabl": 2, "enhanc": [2, 3], "entri": 3, "error": 3, "exampl": [3, 5], "field": 3, "file": [0, 2, 3, 5], "finish": 3, "fix": [2, 3], "footer": 5, "from": 2, "gener": 5, "get": 2, "git": 5, "git_handl": 0, "handler": 0, "have": 3, "header": 5, "help": 5, "implement": 3, "indic": 1, "init": 3, "initi": 0, "integr": 3, "intern": [3, 5], "issu": [3, 5], "line": 2, "main": 0, "make": 3, "manag": 0, "messag": 0, "miss": 3, "modul": 0, "new": 3, "note": [0, 4, 5], "now": 3, "octob": 3, "option": 3, "out": 3, "output": [2, 5], "path": 3, "pipe": 3, "pretti": 3, "print": 3, "prune": [0, 5], "put": 3, "quiet": 2, "relat": [3, 5], "releas": [0, 4, 5], "remov": 2, "render": 3, "repo": 5, "section": 3, "set": 0, "specifi": 5, "start": 3, "support": 5, "tabl": 1, "templat": [0, 3, 5], "test": 3, "titl": 3, "top": 3, "updat": 3, "us": 5, "usag": 5, "user": 3, "util": 0, "version": [2, 3, 4, 5], "via": 5, "welcom": 1, "without": 2, "write": [2, 3], "yaml": [0, 3, 5]}})
\ No newline at end of file
diff --git a/docs/using-brassy.html b/docs/using-brassy.html
index 3d952c0..41e247c 100644
--- a/docs/using-brassy.html
+++ b/docs/using-brassy.html
@@ -7,10 +7,10 @@
 
     <title>Using Brassy &#8212; brassy 0.0.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
     <script src="_static/documentation_options.js?v=47de8214"></script>
-    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -306,6 +306,46 @@ <h3>Adding Headers and/or Footers<a class="headerlink" href="#adding-headers-and
 </div>
 </section>
 </section>
+<section id="related-issue">
+<h2>Related Issue<a class="headerlink" href="#related-issue" title="Link to this heading">¶</a></h2>
+<p>Brassy can link issues (aka tasks, bugs, cards, etc.) to changes.</p>
+<p>For example:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">continuous integration</span><span class="p">:</span>
+<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;Delete</span><span class="nv"> </span><span class="s">repo</span><span class="nv"> </span><span class="s">upon</span><span class="nv"> </span><span class="s">push&#39;</span>
+<span class="w">  </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;I</span><span class="nv"> </span><span class="s">am</span><span class="nv"> </span><span class="s">done</span><span class="nv"> </span><span class="s">coding.</span><span class="nv"> </span><span class="s">Just</span><span class="nv"> </span><span class="s">delete</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">repo.&#39;</span>
+<span class="w">  </span><span class="nt">files</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">deleted</span><span class="p">:</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;main.py&#39;</span>
+<span class="w">    </span><span class="nt">added</span><span class="p">:</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;delete-everything.py&#39;</span>
+<span class="w">  </span><span class="nt">related-issue</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">number</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">999</span>
+<span class="w">    </span><span class="nt">repo_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;https://github.com/torvalds/linux&#39;</span>
+</pre></div>
+</div>
+<p>links the change “Delete repo upon push” to issue #999 on the linked linux repo.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>Issue information isn’t rendered in generated release notes by default.
+You must (currently) change your release generation template to include
+issue info in your release notes.</p>
+</div>
+<section id="support-for-internal-repos">
+<h3>Support for Internal Repos<a class="headerlink" href="#support-for-internal-repos" title="Link to this heading">¶</a></h3>
+<p>Some repositories aren’t something you can share a link for.
+For example, they might be on an internal server or on your
+personal laptop.</p>
+<p>In these cases, you can specify issues without a URL. They must follow this pattern:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Repo</span> <span class="n">Name</span> <span class="n">Or</span> <span class="n">Other</span> <span class="n">String</span><span class="c1">#999 - Description or other string</span>
+</pre></div>
+</div>
+<p>For example:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">related-issue</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">internal</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Brassy#0</span><span class="nv"> </span><span class="s">-</span><span class="nv"> </span><span class="s">Fake</span><span class="nv"> </span><span class="s">issue</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">an</span><span class="nv"> </span><span class="s">example</span><span class="nv"> </span><span class="s">for</span><span class="nv"> </span><span class="s">change&quot;</span>
+</pre></div>
+</div>
+</section>
+</section>
 <section id="change-yaml-directory">
 <h2>Change YAML directory<a class="headerlink" href="#change-yaml-directory" title="Link to this heading">¶</a></h2>
 <p>By default brassy works in your current working directory.</p>
@@ -449,6 +489,7 @@ <h1 class="logo"><a href="index.html">brassy</a></h1>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Using Brassy</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#example-usage">Example usage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#generate-release-notes">Generate release notes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#related-issue">Related Issue</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#change-yaml-directory">Change YAML directory</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#prune-yaml-file">Prune YAML file</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#controlling-cli-output">Controlling CLI Output</a></li>
@@ -484,7 +525,7 @@ <h3>Related Topics</h3>
       &#169;.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
       
       |
diff --git a/pyproject.toml b/pyproject.toml
index e9ca655..b0a76a8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -32,6 +32,7 @@ doc = [
     "sphinx",                    # Required for building documentation, v7.2 errors
     "sphinxcontrib-runcmd",      # Required for running shell commands in documentation
     "sphinxcontrib-napoleon",    # Required for Google-style docstrings
+    "sphinx-argparse",    # Required for Google-style docstrings
     "pinkrst", # for rst formatting
     "black", # for rst formatting
 ]
diff --git a/setup.py b/setup.py
index 0a57ab0..7146d75 100644
--- a/setup.py
+++ b/setup.py
@@ -22,6 +22,11 @@
         "dateparser",
         "pinkrst",
         "black",
-        "pytest"
+        "pytest",
+        "sphinx-argparse",    # Required for Google-style docstrings
+        "sphinxcontrib-runcmd",      # Required for running shell commands in documentation
+        "sphinxcontrib-napoleon",    # Required for Google-style docstrings
+        "sphinx-argparse",    # Required for Google-style docstrings
+        "sphinx",                    # Required for building documentation, v7.2 errors
     ],
 )
diff --git a/src/brassy/utils/git_handler.py b/src/brassy/utils/git_handler.py
index 06161d3..f2a9abe 100644
--- a/src/brassy/utils/git_handler.py
+++ b/src/brassy/utils/git_handler.py
@@ -3,14 +3,26 @@
 
 def get_git_status(repo_path="."):
     """
-    Retrieves the status of files in the given Git repository.
+    Retrieve the status of files in the specified Git repository.
 
-    Parameters:
-    repo_path (str): The path to the Git repository. Defaults to the current directory.
+    Parameters
+    ----------
+    repo_path : str, optional
+        The path to the Git repository. Defaults to the current directory.
 
-    Returns:
-    dict: A dictionary with keys 'added', 'modified', 'deleted', and 'renamed',
-          each containing a list of file paths that match the respective status.
+    Returns
+    -------
+    dict
+        A dictionary with the following keys:
+
+        - 'added': list of str
+            List of file paths for files that have been added.
+        - 'modified': list of str
+            List of file paths for files that have been modified.
+        - 'deleted': list of str
+            List of file paths for files that have been deleted.
+        - 'renamed': list of str
+            List of file paths for files that have been renamed.
     """
 
     # Open the repository
@@ -20,7 +32,8 @@ def get_git_status(repo_path="."):
     try:
         current_branch = repo.head
     except pygit2.GitError:
-        raise pygit2.GitError(f"{repo_path} is not a git repo or does not have a head")
+        raise pygit2.GitError(
+            f"{repo_path} is not a git repo or does not have a head")
 
     # Get the main branch reference
     main_branch = repo.branches["main"]