Skip to content

Commit

Permalink
deploy: 4f32639
Browse files Browse the repository at this point in the history
  • Loading branch information
gastmaier committed Dec 4, 2024
1 parent 0b7bfbd commit 0a0b343
Show file tree
Hide file tree
Showing 52 changed files with 6,552 additions and 151 deletions.
2 changes: 1 addition & 1 deletion _static/app.umd.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _static/app.umd.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _static/style.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _static/style.min.css.map

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions ci.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

<title>Continuous integration &#8212; Doctools documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
<link rel="stylesheet" type="text/css" href="_static/style.min.css?v=a8db6a77" />
<link rel="stylesheet" type="text/css" href="_static/style.min.css?v=ab97267f" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="" src="_static/app.umd.js?v=e42c9fe4"></script>
<script defer="" src="_static/app.umd.js?v=689b8755"></script>
<link rel="icon" href="_static/icon.svg"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -93,7 +93,7 @@
<div class="localtoc">
<div class="tocwrapper">
<div>
<div class="localtoc-header">On this page</div>
<div class="localtoc-header"></div>
<a id="scroll-up" href="#top-anchor" title="Back to top"></a>
</div>
<nav>
Expand Down Expand Up @@ -164,9 +164,9 @@
<div class="body" role="main">

<section id="continuous-integration">
<span id="ci"></span><h1>Continuous integration<a class="headerlink" href="#continuous-integration" title="Link to this heading">#</a></h1>
<span id="ci"></span><h1>Continuous integration<a class="headerlink" href="#continuous-integration" title="Link to this heading"></a></h1>
<section id="doctools-package-pipeline">
<h2>Doctools package pipeline<a class="headerlink" href="#doctools-package-pipeline" title="Link to this heading">#</a></h2>
<h2>Doctools package pipeline<a class="headerlink" href="#doctools-package-pipeline" title="Link to this heading"></a></h2>
<p>Doctools has a continuous deployment integration pipeline that works as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> ┌──────────────────┐
┌─►│Build Doc &amp; Deploy├─┐
Expand Down Expand Up @@ -229,30 +229,30 @@ <h2>Doctools package pipeline<a class="headerlink" href="#doctools-package-pipel
</ul>
</section>
<section id="documentation-build-and-deployment">
<h2>Documentation build and deployment<a class="headerlink" href="#documentation-build-and-deployment" title="Link to this heading">#</a></h2>
<h2>Documentation build and deployment<a class="headerlink" href="#documentation-build-and-deployment" title="Link to this heading"></a></h2>
<p>Doctools is developed to work offline, in a local server, as a rolling release
(e.g. on GitHub Page)s and versioned in a dedicated server (with orchestration).</p>
<section id="local">
<span id="ci-local"></span><h3>Local<a class="headerlink" href="#local" title="Link to this heading">#</a></h3>
<span id="ci-local"></span><h3>Local<a class="headerlink" href="#local" title="Link to this heading"></a></h3>
<p>For offline and local server, a <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> suffice to generate the
documentation.</p>
<p>To serve the build in a local server, Python built-in server can be used:</p>
<div class="code-shell"><div><div class="no-select float-left highlight-default notranslate"><div class="highlight"><pre><span></span>~$
</pre></div>
</div>
<div class="bold highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>http.server<span class="w"> </span>-d<span class="w"> </span>/path/to/docs/_build/html
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>http.server<span class="w"> </span>-d<span class="w"> </span>/path/to/docs/_build/html
</pre></div>
</div>
<div class="clear-left"></div></div></div><p>Or with hot reload using <a class="reference internal" href="cli.html#author-mode"><span class="std std-ref">Author Mode</span></a>:</p>
<div class="code-shell"><div><div class="no-select float-left highlight-default notranslate"><div class="highlight"><pre><span></span>~$
</pre></div>
</div>
<div class="bold highlight-bash notranslate"><div class="highlight"><pre><span></span>adoc<span class="w"> </span>author-mode<span class="w"> </span>-d<span class="w"> </span>/path/to/docs
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>adoc<span class="w"> </span>author-mode<span class="w"> </span>-d<span class="w"> </span>/path/to/docs
</pre></div>
</div>
<div class="clear-left"></div></div></div></section>
<section id="rolling-release">
<span id="ci-rolling-release"></span><h3>Rolling release<a class="headerlink" href="#rolling-release" title="Link to this heading">#</a></h3>
<span id="ci-rolling-release"></span><h3>Rolling release<a class="headerlink" href="#rolling-release" title="Link to this heading"></a></h3>
<p>For a rolling release, a workflow file is used.</p>
<p>With GitHub Actions, the following workflow file is recommended:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">on</span><span class="p">:</span>
Expand Down Expand Up @@ -354,7 +354,7 @@ <h2>Documentation build and deployment<a class="headerlink" href="#documentation
</div>
</section>
<section id="versioned">
<span id="ci-versioned"></span><h3>Versioned<a class="headerlink" href="#versioned" title="Link to this heading">#</a></h3>
<span id="ci-versioned"></span><h3>Versioned<a class="headerlink" href="#versioned" title="Link to this heading"></a></h3>
<p>The live versioned version requires additional orchestration than the
<a class="reference internal" href="#ci-rolling-release"><span class="std std-ref">Rolling release</span></a>.
Store each version in separated folders in the root path, e.g.
Expand All @@ -376,7 +376,7 @@ <h2>Documentation build and deployment<a class="headerlink" href="#documentation
<div class="code-shell"><div><div class="no-select float-left highlight-default notranslate"><div class="highlight"><pre><span></span>~$
</pre></div>
</div>
<div class="bold highlight-bash notranslate"><div class="highlight"><pre><span></span>ls<span class="w"> </span>-d<span class="w"> </span>*/<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-f1<span class="w"> </span>-d<span class="s1">&#39;/&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>--raw-input<span class="w"> </span>.<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>--slurp<span class="w"> </span>.<span class="w"> </span>&gt;<span class="w"> </span>tags.json
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ls<span class="w"> </span>-d<span class="w"> </span>*/<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-f1<span class="w"> </span>-d<span class="s1">&#39;/&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>--raw-input<span class="w"> </span>.<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>--slurp<span class="w"> </span>.<span class="w"> </span>&gt;<span class="w"> </span>tags.json
</pre></div>
</div>
<div class="clear-left"></div></div></div><p>That means, take all directories in the root path and store as JSON.</p>
Expand Down
Loading

0 comments on commit 0a0b343

Please sign in to comment.