Skip to content

Commit

Permalink
deploy: 2ec4c00
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 8, 2025
1 parent 8fa5cd7 commit 7782fda
Show file tree
Hide file tree
Showing 19 changed files with 67 additions and 67 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
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: 76f7a0b124de0a2ec25f601d4b894fbf
config: 960523553d8373b1fec8dcee5f87dac7
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; isee 0.2.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand Down
16 changes: 8 additions & 8 deletions _modules/isee/common.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>isee.common &mdash; isee 0.2.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=fd3f3429" />
Expand Down Expand Up @@ -90,15 +90,15 @@ <h1>Source code for isee.common</h1><div class="highlight"><pre>

<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">glob</span>
<span class="kn">from</span> <span class="nn">wads.util</span> <span class="kn">import</span> <span class="n">git</span> <span class="k">as</span> <span class="n">wads_git</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">glob</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">wads.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">git</span> <span class="k">as</span> <span class="n">wads_git</span>


<div class="viewcode-block" id="git">
<a class="viewcode-back" href="../../module_docs/isee/common.html#isee.common.git">[docs]</a>
<span class="k">def</span> <span class="nf">git</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">work_tree</span><span class="o">=</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="n">git_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">git</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">work_tree</span><span class="o">=</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="n">git_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Execute a git command and return the output.</span>

Expand All @@ -124,7 +124,7 @@ <h1>Source code for isee.common</h1><div class="highlight"><pre>

<div class="viewcode-block" id="get_env_var">
<a class="viewcode-back" href="../../module_docs/isee/common.html#isee.common.get_env_var">[docs]</a>
<span class="k">def</span> <span class="nf">get_env_var</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_env_var</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get the value of an environment variable.</span>
<span class="sd"> If the variable is not defined or is empty, raise a RuntimeError.</span>
Expand Down Expand Up @@ -157,7 +157,7 @@ <h1>Source code for isee.common</h1><div class="highlight"><pre>



<span class="k">def</span> <span class="nf">get_file_path</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">root_path</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_file_path</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">root_path</span><span class="p">):</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">root_path</span> <span class="o">+</span> <span class="sa">f</span><span class="s1">&#39;/**/</span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">recursive</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
Expand Down
30 changes: 15 additions & 15 deletions _modules/isee/generation_utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>isee.generation_utils &mdash; isee 0.2.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=fd3f3429" />
Expand Down Expand Up @@ -88,24 +88,24 @@ <h1>Source code for isee.generation_utils</h1><div class="highlight"><pre>

<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">partial</span>
<span class="kn">from</span> <span class="nn">warnings</span> <span class="kn">import</span> <span class="n">warn</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">partial</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">warnings</span><span class="w"> </span><span class="kn">import</span> <span class="n">warn</span>

<span class="kn">import</span> <span class="nn">semver</span>
<span class="kn">from</span> <span class="nn">epythet.autogen</span> <span class="kn">import</span> <span class="n">make_autodocs</span>
<span class="kn">from</span> <span class="nn">epythet.setup_docsrc</span> <span class="kn">import</span> <span class="n">make_docsrc</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">semver</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">epythet.autogen</span><span class="w"> </span><span class="kn">import</span> <span class="n">make_autodocs</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">epythet.setup_docsrc</span><span class="w"> </span><span class="kn">import</span> <span class="n">make_docsrc</span>

<span class="kn">from</span> <span class="nn">wads.pack</span> <span class="kn">import</span> <span class="n">versions_from_different_sources</span><span class="p">,</span> <span class="n">validate_versions</span>
<span class="kn">from</span> <span class="nn">isee.common</span> <span class="kn">import</span> <span class="n">get_env_var</span><span class="p">,</span> <span class="n">git</span> <span class="k">as</span> <span class="n">_git</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">wads.pack</span><span class="w"> </span><span class="kn">import</span> <span class="n">versions_from_different_sources</span><span class="p">,</span> <span class="n">validate_versions</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">isee.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_env_var</span><span class="p">,</span> <span class="n">git</span> <span class="k">as</span> <span class="n">_git</span>

<span class="n">DFLT_NEW_VERSION</span> <span class="o">=</span> <span class="s1">&#39;0.1.0&#39;</span> <span class="c1"># Default version if no tags are found</span>


<div class="viewcode-block" id="get_new_version">
<a class="viewcode-back" href="../../module_docs/isee/generation_utils.html#isee.generation_utils.get_new_version">[docs]</a>
<span class="k">def</span> <span class="nf">get_new_version</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_new_version</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">work_tree</span><span class="o">=</span><span class="s1">&#39;.&#39;</span><span class="p">,</span>
<span class="n">version_patch_prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
Expand All @@ -120,7 +120,7 @@ <h1>Source code for isee.generation_utils</h1><div class="highlight"><pre>

<span class="n">git</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">_git</span><span class="p">,</span> <span class="n">work_tree</span><span class="o">=</span><span class="n">work_tree</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">bump</span><span class="p">(</span><span class="n">latest</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">bump</span><span class="p">(</span><span class="n">latest</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Bump the version based on the commit message.</span>

Expand All @@ -140,7 +140,7 @@ <h1>Source code for isee.generation_utils</h1><div class="highlight"><pre>
<span class="c1"># Default to bumping the patch version</span>
<span class="k">return</span> <span class="n">semver</span><span class="o">.</span><span class="n">bump_patch</span><span class="p">(</span><span class="n">latest</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">format_version</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">format_version</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Format the version by adding the patch prefix.</span>

Expand Down Expand Up @@ -173,7 +173,7 @@ <h1>Source code for isee.generation_utils</h1><div class="highlight"><pre>

<div class="viewcode-block" id="gen_semver">
<a class="viewcode-back" href="../../module_docs/isee/generation_utils.html#isee.generation_utils.gen_semver">[docs]</a>
<span class="k">def</span> <span class="nf">gen_semver</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="nf">gen_semver</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">dir_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">version_patch_prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
Expand Down Expand Up @@ -207,7 +207,7 @@ <h1>Source code for isee.generation_utils</h1><div class="highlight"><pre>
<span class="c1"># return version</span>


<span class="k">def</span> <span class="nf">generate_documentation</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">project_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">generate_documentation</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">project_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">project_dir</span><span class="p">:</span>
<span class="n">project_dir</span> <span class="o">=</span> <span class="n">get_env_var</span><span class="p">(</span><span class="s1">&#39;GITHUB_WORKSPACE&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">project_dir</span> <span class="o">+</span> <span class="s1">&#39;/docsrc&#39;</span><span class="p">):</span>
Expand Down
Loading

0 comments on commit 7782fda

Please sign in to comment.