Skip to content

Commit

Permalink
Deploy preview for PR 98 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
grst committed Jan 30, 2025
1 parent 1248301 commit 418ec60
Show file tree
Hide file tree
Showing 25 changed files with 54 additions and 48 deletions.
4 changes: 2 additions & 2 deletions pr-preview/pr-98/CHANGELOG.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Configuration" href="cli_configuration.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
3 changes: 2 additions & 1 deletion pr-preview/pr-98/_sources/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ For more details, please refer to [Configuration files](user_guide/params_files.

## Implementing a stage

A stage is a single step in your analysis and usually generates some kind of output data from input data. The input data can also be supplied by previous stages. To create a stage, use the `dso create stage` command and select either the _bash_ or _quarto_ template as a starting-point.
A stage is a single step in your analysis and usually generates some kind of output data from input data. The input data can also be supplied by previous stages. To create a stage, use the `dso create stage` command and select either the _bash_ or one of the _quarto_
[templates](user_guide/templates.md) as a starting-point.

The essential files of a stage are:

Expand Down
4 changes: 3 additions & 1 deletion pr-preview/pr-98/_sources/user_guide/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Folder templates:

Stage templates:

- [quarto](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates/stage/quarto) - Template for quarto notebook in R
- [quarto_r](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates/stage/quarto) - Template for quarto notebook in R
- [quarto_py](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates/stage/quarto) - Template for quarto notebook in Python (quarto markdown (`.qmd`) format)
- [quarto_r](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates/stage/quarto) - Template for quarto notebook in Python (jupyter notebook (`.ipynb`) format)
- [bash](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates/stage/bash) - Template for executing a bash snippet

The source code of the templates can be [inspected on GitHub](https://github.com/Boehringer-Ingelheim/dso/tree/main/src/dso/templates).
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/pr-98/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.dev1+g9166e3c',
VERSION: '0.1.dev1+g6481831',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/cli_command_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Installation" href="cli_installation.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/cli_configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Command reference" href="cli_command_reference.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
6 changes: 3 additions & 3 deletions pr-preview/pr-98/cli_installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="FAQ" href="faq.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down Expand Up @@ -369,7 +369,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
</div>
<p>This command installs the <code class="docutils literal notranslate"><span class="pre">dso</span></code> binary:</p>
<div class="highlight-ansi-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>dso<span class="w"> </span>--version
dso, version 0.1.dev1+g9166e3c
dso, version 0.1.dev1+g6481831
</pre></div>
</div>
<p>If you prefer to manage the Python environment yourself, you can use <code class="docutils literal notranslate"><span class="pre">pip</span></code> as usual:</p>
Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Changelog" href="CHANGELOG.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Quarto integration" href="user_guide/quarto.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/generated/dso._lint.DSO001.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../_static/documentation_options.js?v=e35243cb"></script>
<script src="../_static/documentation_options.js?v=22a78dfd"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Linting" href="../user_guide/linting.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -53,7 +53,7 @@
<link rel="search" title="Search" href="search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
7 changes: 4 additions & 3 deletions pr-preview/pr-98/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="DSO: data science operations" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down Expand Up @@ -439,7 +439,8 @@ <h2>Configuration files<a class="headerlink" href="#configuration-files" title="
</section>
<section id="implementing-a-stage">
<h2>Implementing a stage<a class="headerlink" href="#implementing-a-stage" title="Link to this heading">#</a></h2>
<p>A stage is a single step in your analysis and usually generates some kind of output data from input data. The input data can also be supplied by previous stages. To create a stage, use the <code class="docutils literal notranslate"><span class="pre">dso</span> <span class="pre">create</span> <span class="pre">stage</span></code> command and select either the <em>bash</em> or <em>quarto</em> template as a starting-point.</p>
<p>A stage is a single step in your analysis and usually generates some kind of output data from input data. The input data can also be supplied by previous stages. To create a stage, use the <code class="docutils literal notranslate"><span class="pre">dso</span> <span class="pre">create</span> <span class="pre">stage</span></code> command and select either the <em>bash</em> or one of the <em>quarto</em>
<a class="reference internal" href="user_guide/templates.html"><span class="std std-doc">templates</span></a> as a starting-point.</p>
<p>The essential files of a stage are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dvc.yaml</span></code>: The DVC configuration file that defines your data pipelines, dependencies, and outputs.</p></li>
Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -66,7 +66,7 @@
<link rel="next" title="Getting started" href="getting_started.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
2 changes: 1 addition & 1 deletion pr-preview/pr-98/objects.inv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Sphinx inventory version 2
# Project: Project name not set
# Version: 0.1.dev1+g9166e3c
# Version: 0.1.dev1+g6481831
# The remainder of this file is compressed using zlib.
xڝT�r� ��)�i�r�on���I�I�G��D�A�6o_`%������g���jR�/��7���J���bV����@����zVH��@�X0E�W��ξ>?�狠g�ZK��:�W�,���6������:gĶqp�����7s~�����j)��g�Į��F1'�"����QP^��н=Sa����� �[�Y��������qM��K���F���*A�2cRL��T���ΧP R�(�u�0�í�ډ��j<rJ��% E����5H1��%���c��H�x���'&�\�o!y��t rT��K�t��%R3_�{���irĜ���l�Sɉ6%��`+�ò�h�R��3]�Eh@� � T�1H�`���U%|1K©��2;I׀�f~��X����q�a� zB���p���#��`h�js��p�66��*�Q�3|f�aհ8�!��M�o�4���&�xHոm���`',R�Ƞ� <�Anʱ'��?��We;����-�'�D�'$N�8��~�'���m'��#a5�� �k�6a׼��'��5"����8{z;�B:���?ؼ��
Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -54,7 +54,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />


</head>
Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/python_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -64,7 +64,7 @@
<link rel="prev" title="Usage" href="python_usage.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/python_usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Contributing guide" href="contributing.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=e35243cb"></script>
<script src="_static/documentation_options.js?v=22a78dfd"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -55,7 +55,7 @@
<link rel="search" title="Search" href="#" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
2 changes: 1 addition & 1 deletion pr-preview/pr-98/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions pr-preview/pr-98/user_guide/linting.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../_static/documentation_options.js?v=e35243cb"></script>
<script src="../_static/documentation_options.js?v=22a78dfd"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="uv integration" href="uv.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
4 changes: 2 additions & 2 deletions pr-preview/pr-98/user_guide/params_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../_static/documentation_options.js?v=e35243cb"></script>
<script src="../_static/documentation_options.js?v=22a78dfd"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -67,7 +67,7 @@
<link rel="prev" title="Project and stage templates" href="templates.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.dev1+g9166e3c" />
<meta name="docsearch:version" content="0.1.dev1+g6481831" />
</head>


Expand Down
Loading

0 comments on commit 418ec60

Please sign in to comment.