Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gardener-robot-ci-1
gardener-robot-ci-1 committed Nov 5, 2024
1 parent 8a54dc0 commit c49a5d0
Show file tree
Hide file tree
Showing 23 changed files with 45 additions and 33 deletions.
2 changes: 1 addition & 1 deletion genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<title>Index &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>CC-Utils - Build Pipeline Reference Manual &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion pipeline.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Pipeline Definition &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion pipeline_job.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Pipeline Job &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion pipeline_step.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Pipeline Steps &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion release_notes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Release Notes Process &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<title>Search &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion traits.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Pipeline Definition Traits &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/component_descriptor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>component_descriptor Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/cronjob.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>cronjob Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
4 changes: 2 additions & 2 deletions traits/draft_release.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>draft_release Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down Expand Up @@ -118,8 +118,8 @@ <h1><em>draft_release</em> Trait<a class="headerlink" href="#draft-release-trait
<h2>Dependencies<a class="headerlink" href="#trait-draft-release" title="Link to this heading"></a></h2>
<p>This trait requires the following traits to be declared:</p>
<ul class="simple">
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
</ul>
</section>
<p>Declaring jobs will create or update draft-release-notes that will automatically be collected for
Expand Down
2 changes: 1 addition & 1 deletion traits/image_scan.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>image_scan Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/notifications.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>notifications Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/options.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>options Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/publish.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>publish Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/pullrequest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>pull-request Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
32 changes: 22 additions & 10 deletions traits/release.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>release Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down Expand Up @@ -263,13 +263,19 @@ <h2>assets[] <em>(BuildstepLogAsset)</em> Attributes<a class="headerlink" href="
<td><p>str</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p>purposes</p></td>
<tr class="row-odd"><td><p>artefact_extra_id</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>Dict[str, str]</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>purposes</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>List[str]</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>comment</p></td>
<tr class="row-odd"><td><p>comment</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str | None</p></td>
Expand Down Expand Up @@ -318,37 +324,43 @@ <h2>assets[] <em>(BuildstepFileAsset)</em> Attributes<a class="headerlink" href=
<td><p>str</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p>purposes</p></td>
<tr class="row-odd"><td><p>artefact_extra_id</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>Dict[str, str]</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>purposes</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>List[str]</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>comment</p></td>
<tr class="row-odd"><td><p>comment</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str | None</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p>step_output_dir</p></td>
<tr class="row-even"><td><p>step_output_dir</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>path</p></td>
<tr class="row-odd"><td><p>path</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p>prefix</p></td>
<tr class="row-even"><td><p>prefix</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str | None</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p>mode</p></td>
<tr class="row-odd"><td><p>mode</p></td>
<td><p>no</p></td>
<td><p><code class="code docutils literal notranslate"><span class="pre">tar</span></code></p></td>
<td><p>FileAssetMode</p></td>
Expand Down Expand Up @@ -441,8 +453,8 @@ <h2>on_tag_conflict Enumeration Values<a class="headerlink" href="#trait-release
<h2>Dependencies<a class="headerlink" href="#trait-release" title="Link to this heading"></a></h2>
<p>This trait requires the following traits to be declared:</p>
<ul class="simple">
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
</ul>
</section>
<p>This trait add release job semantics to the declaring build job.</p>
Expand Down
2 changes: 1 addition & 1 deletion traits/scan_sources.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>scan_sources Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/scheduling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>scheduling Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/slack.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>slack Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/update_component_deps.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>update_component_deps Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion traits/version.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>version Trait &mdash; cc-utils documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=6436cbf1" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<link rel="shortcut icon" href="../_static/favicon.ico"/>
Expand Down

0 comments on commit c49a5d0

Please sign in to comment.