Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 25, 2024
1 parent 2062ad4 commit 2f7eeef
Show file tree
Hide file tree
Showing 8 changed files with 69 additions and 7 deletions.
8 changes: 8 additions & 0 deletions _sources/dflow.client.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ dflow.client.v1alpha1\_artifact module
:undoc-members:
:show-inheritance:

dflow.client.v1alpha1\_dag\_task module
---------------------------------------

.. automodule:: dflow.client.v1alpha1_dag_task
:members:
:undoc-members:
:show-inheritance:

dflow.client.v1alpha1\_lifecycle\_hook module
---------------------------------------------

Expand Down
4 changes: 4 additions & 0 deletions dflow.client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<section id="dflow-client-v1alpha1-artifact-module">
<h2>dflow.client.v1alpha1_artifact module<a class="headerlink" href="#dflow-client-v1alpha1-artifact-module" title="Link to this heading"></a></h2>
</section>
<section id="dflow-client-v1alpha1-dag-task-module">
<h2>dflow.client.v1alpha1_dag_task module<a class="headerlink" href="#dflow-client-v1alpha1-dag-task-module" title="Link to this heading"></a></h2>
</section>
<section id="dflow-client-v1alpha1-lifecycle-hook-module">
<h2>dflow.client.v1alpha1_lifecycle_hook module<a class="headerlink" href="#dflow-client-v1alpha1-lifecycle-hook-module" title="Link to this heading"></a></h2>
</section>
Expand Down Expand Up @@ -81,6 +84,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#">dflow.client package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#dflow-client-v1alpha1-artifact-module">dflow.client.v1alpha1_artifact module</a></li>
<li><a class="reference internal" href="#dflow-client-v1alpha1-dag-task-module">dflow.client.v1alpha1_dag_task module</a></li>
<li><a class="reference internal" href="#dflow-client-v1alpha1-lifecycle-hook-module">dflow.client.v1alpha1_lifecycle_hook module</a></li>
<li><a class="reference internal" href="#dflow-client-v1alpha1-parameter-module">dflow.client.v1alpha1_parameter module</a></li>
<li><a class="reference internal" href="#dflow-client-v1alpha1-retry-strategy-module">dflow.client.v1alpha1_retry_strategy module</a></li>
Expand Down
39 changes: 35 additions & 4 deletions dflow.html
View file

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions dflow.python.html
View file

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1244,6 +1244,12 @@ <h2 id="G">G</h2>

<ul>
<li><a href="dflow.html#dflow.ArgoWorkflow.get_step">(dflow.ArgoWorkflow method)</a>
</li>
</ul></li>
<li><a href="dflow.html#dflow.argo_objects.ArgoWorkflow.get_sub_nodes">get_sub_nodes() (dflow.argo_objects.ArgoWorkflow method)</a>

<ul>
<li><a href="dflow.html#dflow.ArgoWorkflow.get_sub_nodes">(dflow.ArgoWorkflow method)</a>
</li>
</ul></li>
<li><a href="dflow.plugins.html#dflow.plugins.bohrium.TiefblueClient.get_token">get_token() (dflow.plugins.bohrium.TiefblueClient method)</a>
Expand Down Expand Up @@ -1831,6 +1837,12 @@ <h2 id="R">R</h2>
</li>
<li><a href="dflow.plugins.html#dflow.plugins.ray.RayClusterExecutor">RayClusterExecutor (class in dflow.plugins.ray)</a>
</li>
<li><a href="dflow.html#dflow.argo_objects.ArgoWorkflow.record_generation">record_generation() (dflow.argo_objects.ArgoWorkflow method)</a>

<ul>
<li><a href="dflow.html#dflow.ArgoWorkflow.record_generation">(dflow.ArgoWorkflow method)</a>
</li>
</ul></li>
<li><a href="dflow.html#dflow.Step.record_input_artifacts">record_input_artifacts() (dflow.Step method)</a>

<ul>
Expand Down
5 changes: 5 additions & 0 deletions modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ <h1>src<a class="headerlink" href="#src" title="Link to this heading">¶</a></h1
<li class="toctree-l3"><a class="reference internal" href="dflow.client.html">dflow.client package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#dflow-client-v1alpha1-artifact-module">dflow.client.v1alpha1_artifact module</a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#dflow-client-v1alpha1-dag-task-module">dflow.client.v1alpha1_dag_task module</a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#dflow-client-v1alpha1-lifecycle-hook-module">dflow.client.v1alpha1_lifecycle_hook module</a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#dflow-client-v1alpha1-parameter-module">dflow.client.v1alpha1_parameter module</a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.client.html#dflow-client-v1alpha1-retry-strategy-module">dflow.client.v1alpha1_retry_strategy module</a></li>
Expand Down Expand Up @@ -107,6 +108,8 @@ <h1>src<a class="headerlink" href="#src" title="Link to this heading">¶</a></h1
<li class="toctree-l3"><a class="reference internal" href="dflow.html#dflow.argo_objects.ArgoWorkflow"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.argo_objects.ArgoWorkflow.get_duration"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_duration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.argo_objects.ArgoWorkflow.get_step"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_step()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.argo_objects.ArgoWorkflow.get_sub_nodes"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_sub_nodes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.argo_objects.ArgoWorkflow.record_generation"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.record_generation()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dflow.html#dflow.argo_objects.fnva"><code class="docutils literal notranslate"><span class="pre">fnva()</span></code></a></li>
Expand Down Expand Up @@ -620,6 +623,8 @@ <h1>src<a class="headerlink" href="#src" title="Link to this heading">¶</a></h1
<li class="toctree-l3"><a class="reference internal" href="dflow.html#dflow.ArgoWorkflow"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.ArgoWorkflow.get_duration"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_duration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.ArgoWorkflow.get_step"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_step()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.ArgoWorkflow.get_sub_nodes"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.get_sub_nodes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dflow.html#dflow.ArgoWorkflow.record_generation"><code class="docutils literal notranslate"><span class="pre">ArgoWorkflow.record_generation()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dflow.html#dflow.AutonamedDict"><code class="docutils literal notranslate"><span class="pre">AutonamedDict</span></code></a><ul>
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 2f7eeef

Please sign in to comment.