Skip to content

Commit

Permalink
Deployed d632d43 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
tkolzer committed Oct 4, 2023
1 parent 7e4956c commit ded9de5
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 7 deletions.
35 changes: 29 additions & 6 deletions contribute/to_docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -641,27 +641,50 @@
<p>These are the source files for the <a href="https://ultimate-pa.github.io/hanfor/">Hanfor Documentation</a>.</p>
<h1 id="contribute-to-this-documentation">Contribute to this Documentation.<a class="headerlink" href="#contribute-to-this-documentation" title="Permanent link"> #</a></h1>
<h4 id="0-optional-setup-a-virtual-environment">0. (Optional) setup a virtual environment<a class="headerlink" href="#0-optional-setup-a-virtual-environment" title="Permanent link"> #</a></h4>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.31 4.31 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73"/></svg></span> Linux</label><label for="__tabbed_1_2"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m0 93.7 183.6-25.3v177.4H0V93.7zm0 324.6 183.6 25.3V268.4H0v149.9zm203.8 28L448 480V268.4H203.8v177.9zm0-380.6v180.1H448V32L203.8 65.7z"/></svg></span> Windows</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>hanfor/documentation
$<span class="w"> </span>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
$<span class="w"> </span><span class="nb">source</span><span class="w"> </span>venv/bin/activate
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>hanfor<span class="se">\d</span>ocumentation
$<span class="w"> </span>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
$<span class="w"> </span>venv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate.bat
</code></pre></div>
</div>
</div>
</div>
<h4 id="1-install-mkdocs-and-all-dependencies">1. Install <a href="https://www.mkdocs.org/">MkDocs</a> and all dependencies.<a class="headerlink" href="#1-install-mkdocs-and-all-dependencies" title="Permanent link"> #</a></h4>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>pip3<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
</code></pre></div>
<h4 id="2-serve-this-documentation-locally-to-track-your-changes">2. Serve this Documentation locally to track your changes.<a class="headerlink" href="#2-serve-this-documentation-locally-to-track-your-changes" title="Permanent link"> #</a></h4>
<p><div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>hanfor/documentation
<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.31 4.31 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73"/></svg></span> Linux</label><label for="__tabbed_2_2"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m0 93.7 183.6-25.3v177.4H0V93.7zm0 324.6 183.6 25.3V268.4H0v149.9zm203.8 28L448 480V268.4H203.8v177.9zm0-380.6v180.1H448V32L203.8 65.7z"/></svg></span> Windows</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>hanfor/documentation
$<span class="w"> </span>mkdocs<span class="w"> </span>serve
</code></pre></div>
Open your Browser at <a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a>.</p>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>hanfor<span class="se">\d</span>ocumentation
$<span class="w"> </span>mkdocs<span class="w"> </span>serve
</code></pre></div>
</div>
</div>
</div>
<p>Open your Browser at <a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a>.</p>
<h4 id="3-publish-your-changes-to-the-staging-directory">3. Publish your changes to the staging directory.<a class="headerlink" href="#3-publish-your-changes-to-the-staging-directory" title="Permanent link"> #</a></h4>
<p><div class="highlight"><pre><span></span><code>$<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy<span class="w"> </span>--remote-branch<span class="w"> </span>gh-pages-staging
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy<span class="w"> </span>--remote-branch<span class="w"> </span>gh-pages-staging
</code></pre></div>
This will build the Documentation and commit them to the <code>gh-pages-staging</code> branch and push the <code>gh-pages-staging</code> branch to GitHub.
<p>This will build the Documentation and commit them to the <code>gh-pages-staging</code> branch and push the <code>gh-pages-staging</code> branch to GitHub.
If you have the necessary rights, you can then see the results on https://struebli.informatik.uni-freiburg.de/hanfor-docs-staging.</p>
<h4 id="4-publish-your-changes-to-the-live-directory">4. Publish your changes to the live directory<a class="headerlink" href="#4-publish-your-changes-to-the-live-directory" title="Permanent link"> #</a></h4>
<p><div class="highlight"><pre><span></span><code>$<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy
</code></pre></div>
This will build the Documentation and commit them to the <code>gh-pages</code> branch and push the <code>gh-pages</code> branch to GitHub.
<p>This will build the Documentation and commit them to the <code>gh-pages</code> branch and push the <code>gh-pages</code> branch to GitHub.
They will then be immediately available to the world at https://ultimate-pa.github.io/hanfor.</p>


Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit ded9de5

Please sign in to comment.