Deployed 720cfd8 to develop with MkDocs 1.6.1 and mike 2.1.3

develop/404.html

@@ -14,7 +14,7 @@
 
 
       <link rel="icon" href="/super-repo/develop/img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 

develop/development/best-practice/code_style/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1278,12 +1278,12 @@ <h1 id="code-style">Code Style<a class="headerlink" href="#code-style" title="Pe
 Maintaining a consistent code style is crucial for the readability and
 maintainability of a Python project.</p>
 <p>We enforce most of the following guidelines in our
-<a href="https://rl-institut.github.io/super-repository/develop/development/continuous-integration/">Continuous-Integration pipeline</a>
+<a href="https://rl-institut.github.io/super-repo/develop/development/continuous-integration/">Continuous-Integration pipeline</a>
 that check the code automatically.</p>
 <h2 id="1-installation">1. Installation<a class="headerlink" href="#1-installation" title="Permanent link">#</a></h2>
 <p>Before contributing to the project, make sure you have the necessary tools
 installed for code style enforcement.
-We utilize <a href="https://rl-institut.github.io/super-repository/develop/development/continuous-integration/">pre-commit</a>
+We utilize <a href="https://rl-institut.github.io/super-repo/develop/development/continuous-integration/">pre-commit</a>
 to automate code checks before committing changes.</p>
 <h2 id="2-code-formatting">2. Code Formatting<a class="headerlink" href="#2-code-formatting" title="Permanent link">#</a></h2>
 <p>Consistent code formatting enhances readability and reduces unnecessary
@@ -1307,6 +1307,10 @@ <h2 id="6-code-structure-and-organization">6. Code Structure and Organization<a
 <p>Maintain a logical structure within files, grouping related functions and
 classes. Consider the readability of your code and strive for modular,
 well-organized files.</p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/best-practice/continuous_integration/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1332,10 +1332,10 @@ <h2 id="tox-automating-testing">Tox: Automating Testing<a class="headerlink" hre
 </ul>
 <h3 id="install">Install<a class="headerlink" href="#install" title="Permanent link">#</a></h3>
 <p>Install the required package in a python environment. <br>
-💻 <code>pip install tox</code> install tox <br>
-💻 <code>tox</code> run tox locally</p>
+   💻 <code>pip install tox</code> Install tox <br>
+   💻 <code>tox</code> Run tox locally</p>
 <h2 id="adding-and-managing-tests">Adding and Managing Tests<a class="headerlink" href="#adding-and-managing-tests" title="Permanent link">#</a></h2>
-<p>New tests should be placed in the 📝 <code>tests/</code> directory. For example:<br />
+<p>New tests should be placed in the 📝 <code>test/</code> directory. For example:<br />
 - Add a test to validate new functionality.<br />
 - Use <code>pytest</code> for unit tests, or extend 📝 <code>tox.ini</code> for additional test configurations.  </p>
 <p>By combining <code>tox</code> and GitHub Actions, our CI pipeline ensures robust,
@@ -1406,7 +1406,7 @@ <h3 id="test-patterns">Test Patterns<a class="headerlink" href="#test-patterns"
 </li>
 </ol>
 <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">#</a></h3>
-<p>The file 📝 <code>tests/test_example.py</code> contains basic examples for the functions in <br>
+<p>The file 📝 <code>test/test_example.py</code> contains basic examples for the functions in <br>
 📝 <code>super_repo/test_calculator.py</code>.</p>
 <p>In Python, the <code>assert</code> statement is used to test if a condition is true. <br>
 If the condition is false, an AssertionError is raised, indicating the test failed.</p>

develop/development/best-practice/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1121,25 +1121,29 @@ <h1 id="best-practices">Best Practices<a class="headerlink" href="#best-practice
 high standards in a collaborative scientific software environment:</p>
 <ul>
 <li>
-<p><a href="https://rl-institut.github.io/super-repository/develop/development/continuous-integration/"><strong>Continuous Integration (CI)</strong></a>: <br>
+<p><a href="https://rl-institut.github.io/super-repo/develop/development/continuous-integration/"><strong>Continuous Integration (CI)</strong></a>: <br>
   Automating the integration of code changes to catch errors early and maintain a stable codebase.
   CI ensures that all contributions are rigorously tested and integrated seamlessly into the project.</p>
 </li>
 <li>
-<p><a href="https://rl-institut.github.io/super-repository/develop/development/continuous-integration/"><strong>Test-Driven Development (TDD)</strong></a>: <br>
+<p><a href="https://rl-institut.github.io/super-repo/develop/development/continuous-integration/"><strong>Test-Driven Development (TDD)</strong></a>: <br>
   A methodology where tests are written before the actual code implementation. <br>
   TDD promotes robust and well-designed code by enforcing that each feature is accompanied by
   thorough testing from the outset.</p>
 </li>
 <li>
-<p><a href="https://rl-institut.github.io/super-repository/develop/development/continuous-integration/"><strong>Pre-commit Hooks (PCH)</strong></a>: <br>
+<p><a href="https://rl-institut.github.io/super-repo/develop/development/continuous-integration/"><strong>Pre-commit Hooks (PCH)</strong></a>: <br>
   Tools to enforce code
   quality and consistency by running checks or scripts before changes are committed. <br>
   These hooks help identify issues early, improving code hygiene and reducing technical debt.</p>
 </li>
 </ul>
 <p>Following these practices will streamline development, reduce bugs, and foster a
 productive, collaborative coding environment.</p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/best-practice/pre_commit_hooks/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 

develop/development/best-practice/test_driven_development/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1412,9 +1412,11 @@ <h2 id="code-coverage">Code Coverage<a class="headerlink" href="#code-coverage"
 <h2 id="example-implementing-test-cases-for-a-django-app">Example: Implementing Test Cases for a Django App<a class="headerlink" href="#example-implementing-test-cases-for-a-django-app" title="Permanent link">#</a></h2>
 <p>This example demonstrates the TDD approach within a Django app. <br>
 You can run all tests in Django using the following command:</p>
-<p>💻 <code>python manage.py test</code></p>
+<div class="highlight"><pre><span></span><code>💻 `python manage.py test`
+</code></pre></div>
 <p>To run specific test cases, you can provide the app name and the test case:</p>
-<p>💻 <code>python manage.py test app.MyModelViewTestCase</code></p>
+<div class="highlight"><pre><span></span><code>💻 `python manage.py test app.MyModelViewTestCase`
+</code></pre></div>
 <p>This is a Step-by-Step Guide to TDD in Django:</p>
 <h3 id="1-set-up-the-django-app">1. Set Up the Django App<a class="headerlink" href="#1-set-up-the-django-app" title="Permanent link">#</a></h3>
 <p>Ensure that you have a Django app in place that you wish to test.</p>
@@ -1423,7 +1425,7 @@ <h3 id="2-write-a-test-for-the-new-feature">2. Write a Test for the New Feature<
 For example, if you need to create a view that returns a list of objects from
 the database, and a corresponding model to represent the database table,
 your test might look like this: <br>
-    📝 <code>app/tests/my_test.py</code>:</p>
+    📝 <code>app/test/my_test.py</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">django.test</span> <span class="kn">import</span> <span class="n">TestCase</span>
 <span class="kn">from</span> <span class="nn">myapp.models</span> <span class="kn">import</span> <span class="n">MyModel</span>
 

develop/development/collaboration/chat/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1125,14 +1125,18 @@
 
 
 <h1 id="chat">Chat<a class="headerlink" href="#chat" title="Permanent link">#</a></h1>
-<p>For direct communication, this repo uses a public <a href="https://element.io/">Element</a> room. <br>
+<p>For direct communication, this repository uses a public <a href="https://element.io/">Element</a> room. <br>
 This messenger platform is based on the <a href="https://en.wikipedia.org/wiki/Matrix_(protocol)">[matrix]</a>
 communication protocol <br>
 and can be accessed without a mobile phone.</p>
 <p>To engage with the developer and user community, <br>
-login with an existing account (e.g. GitHub) or register a new account.</p>
+login with an existing account (for example GitHub) or register a new account.</p>
 <p>The room name is:
-<a href="https://app.element.io/#/room/#super-repo:matrix.org">Super-Repo:matrix.org</a>. <br></p>
+<a href="https://app.element.io/#/room/#super-repo:matrix.org">Super-Repository:matrix.org</a>. <br></p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/collaboration/code_of_conduct/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1128,7 +1128,11 @@ <h1 id="code-of-conduct">Code of Conduct<a class="headerlink" href="#code-of-con
 <p>This repository is following the <a href="https://github.com/rl-institut/super-repo/blob/production/CODE_OF_CONDUCT.md">Contributor Covenant Code of Conduct</a>. <br></p>
 <p>Everyone is asked to be self-reflective and always maintain a good culture
 of discussion and active participation.
-This includes written communication in this repo and direct encounters in meetings and events.</p>
+This includes written communication in this repository and direct encounters in meetings and events.</p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/collaboration/git/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1426,10 +1426,10 @@ <h2 id="issue-templates">Issue Templates<a class="headerlink" href="#issue-templ
 <p><a href="https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository">Issue Templates</a>
 offer specific functions and default configurations for new issues.</p>
 <ul>
-<li><a href="https://github.com/rl-institut/super-repository/blob/production/.github/ISSUE_TEMPLATE/issue_template_feature.md">Feature Issue</a></li>
-<li><a href="https://github.com/rl-institut/super-repository/blob/production/.github/ISSUE_TEMPLATE/issue_template_bug.md">Bug Issue</a></li>
-<li><a href="https://github.com/rl-institut/super-repository/blob/production/.github/ISSUE_TEMPLATE/issue_template_release.md">Release Issue</a></li>
-<li><a href="https://github.com/rl-institut/super-repository/blob/production/.github/ISSUE_TEMPLATE/issue_template_user_kudos.md">User Kudos Issue</a></li>
+<li><a href="https://github.com/rl-institut/super-repo/blob/production/.github/ISSUE_TEMPLATE/issue_template_feature.md">Feature Issue</a></li>
+<li><a href="https://github.com/rl-institut/super-repo/blob/production/.github/ISSUE_TEMPLATE/issue_template_bug.md">Bug Issue</a></li>
+<li><a href="https://github.com/rl-institut/super-repo/blob/production/.github/ISSUE_TEMPLATE/issue_template_release.md">Release Issue</a></li>
+<li><a href="https://github.com/rl-institut/super-repo/blob/production/.github/ISSUE_TEMPLATE/issue_template_user_kudos.md">User Kudos Issue</a></li>
 </ul>
 <h2 id="pull-request-pr-template">Pull Request (PR) Template<a class="headerlink" href="#pull-request-pr-template" title="Permanent link">#</a></h2>
 <p>The <a href="https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository">Pull Request Template</a>
@@ -1438,9 +1438,9 @@ <h2 id="pull-request-pr-template">Pull Request (PR) Template<a class="headerlink
 <h2 id="github-labels">GitHub Labels<a class="headerlink" href="#github-labels" title="Permanent link">#</a></h2>
 <p>GitHub Labels are used to organize Issues and PR. <br>
 Colours and emoticons improve presentation, see: <br>
-📝 <a href="https://github.com/rl-institut/super-repository/blob/develop/docs/development/git/github-labels.json">github-labels.json</a></p>
+    📝 <a href="https://github.com/rl-institut/super-repo/blob/develop/docs/development/git/github-labels.json">github-labels.json</a></p>
 <h2 id="github-workflows-actions">GitHub Workflows (Actions)<a class="headerlink" href="#github-workflows-actions" title="Permanent link">#</a></h2>
-<p><a href="https://github.com/rl-institut/super-repository/actions">GitHub Actions</a>
+<p><a href="https://github.com/rl-institut/super-repo/actions">GitHub Actions</a>
 are used to automate processes of the repository. <br>
 Main use-cases are building and publishing the documentation and run automated tests.</p>
 <h2 id="pre-commit">Pre-commit<a class="headerlink" href="#pre-commit" title="Permanent link">#</a></h2>
@@ -1450,8 +1450,8 @@ <h2 id="pre-commit">Pre-commit<a class="headerlink" href="#pre-commit" title="Pe
 It is used to improve auto-format code, do linting and run tests before every commit.</p>
 <h3 id="install">Install<a class="headerlink" href="#install" title="Permanent link">#</a></h3>
 <p>Install the required package in a python environment. <br>
-💻 <code>pip install pre-commit</code> install pre-commit <br>
-💻 <code>pre-commit install</code> install pre-commit</p>
+    💻 <code>pip install pre-commit</code> Install pre-commit <br>
+    💻 <code>pre-commit install</code> Install pre-commit</p>
 <h3 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">#</a></h3>
 <p>The hooks are configured in the file 📝 <code>.pre-commit-config.yaml</code>.<br>
 List of implemented hooks:</p>
@@ -1466,16 +1466,16 @@ <h3 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">#
 <li><a href="https://github.com/fsfe/reuse-tool">reuse</a> - License and copyright information</li>
 </ul>
 <h3 id="use">Use<a class="headerlink" href="#use" title="Permanent link">#</a></h3>
-<p>All commits will trigger the hooks automatically.<br>
-💠 <code>git commit file -m "Commit message #IssueNr"</code> to commit</p>
-<p>Commit without running the hooks.<br>
-💠 <code>git commit --no-verify file</code> to commit without hooks</p>
+<p>All commits will trigger the hooks automatically. <br>
+    💠 <code>git commit file -m "Commit message #IssueNr"</code> Commit with message</p>
+<p>Commit without running the hooks. <br>
+    💠 <code>git commit --no-verify file</code> Commit without hooks</p>
 <div class="admonition note">
 <p class="admonition-title">Line endings</p>
 <p>There can be problems with file line endings on Windows, <code>CRLF</code> is used on Windows and <code>LF</code> is used on Linux.</p>
 </div>
-<p>To run the hooks on all files in your repository use:<br>
-💻 <code>pre-commit run --all-files</code></p>
+<p>To run the hooks on all files in your repository use: <br>
+    💻 <code>pre-commit run --all-files</code> Run pre-commit hooks</p>
 <div class="admonition warning">
 <p class="admonition-title">Markdown files / Admonitions</p>
 <p>If the hook is applied to markdown files that include special formatting,

develop/development/collaboration/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1125,6 +1125,10 @@ <h1 id="collaboration">Collaboration<a class="headerlink" href="#collaboration"
 <li>Get in touch with the community on the <a href="https://rl-institut.github.io/super-repo/develop/development/collaboration/chat/">Element Chat</a></li>
 <li>Meet the developers in one of the <a href="https://rl-institut.github.io/super-repo/develop/development/collaboration/meeting/">regular meetings</a></li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/collaboration/license_and_citation/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1257,7 +1257,7 @@ <h2 id="software-license">Software License<a class="headerlink" href="#software-
 as long as you follow the license obligations to give a proper attribution and
 include the license text.</p>
 <p>Please attribute as:</p>
-<p><strong>"Super-Repo" © Reiner Lemoine Institut | MIT License</strong></p>
+<p><strong>"Super-Repository" © Reiner Lemoine Institut | MIT License</strong></p>
 <h3 id="reuse">REUSE<a class="headerlink" href="#reuse" title="Permanent link">#</a></h3>
 <p>This repository follows the <a href="https://reuse.software/">REUSE SOFTWARE</a>
 specification.
@@ -1282,6 +1282,10 @@ <h2 id="contributing">Contributing<a class="headerlink" href="#contributing" tit
 run and modified, you are invited to comment, improve and develop the program as you wish. <br>
 To contribute to the <strong>collaborative development</strong> follow the workflow described in
 <a href="https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>
 
 
 

develop/development/collaboration/meeting/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../../img/favicon_super-repo.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
 
 
 
@@ -1218,6 +1218,10 @@ <h2 id="user-meetings">User Meetings<a class="headerlink" href="#user-meetings"
 <p>The regular user meeting takes place after the developer meeting in the same
 room on the <br>
 <strong>first Wednesday of the month between 9:30 and 10 am</strong>.</p>
+<div class="admonition note">
+<p class="admonition-title">Used Icons</p>
+<p>🐙 GitHub | 💠 git | 📝 File | 💻 Command Line</p>
+</div>