Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependencies and build new docs #45

Merged
merged 1 commit into from
Nov 5, 2024
Merged

Update dependencies and build new docs #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions docs/_modules/brassy/actions/build_release_notes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/actions/init.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/actions/prune_yaml.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/brassy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions docs/_modules/brassy/templates/release_yaml_template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand All @@ -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>

Expand Down Expand Up @@ -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>



Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/templates/settings_template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/utils/CLI.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/utils/file_handler.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
33 changes: 23 additions & 10 deletions docs/_modules/brassy/utils/git_handler.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/brassy/utils/messages.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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>
Expand Down
Loading
Loading