Skip to content

Commit

Permalink
Deployed 6ed2492 to develop with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Documentation committed Dec 3, 2024
1 parent 205dfe7 commit d1cff39
Show file tree
Hide file tree
Showing 6 changed files with 142 additions and 154 deletions.
10 changes: 5 additions & 5 deletions develop/code/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1147,21 +1147,21 @@

<h1 id="install">Install<a class="headerlink" href="#install" title="Permanent link">#</a></h1>
<h2 id="environment-conda">Environment (Conda)<a class="headerlink" href="#environment-conda" title="Permanent link">#</a></h2>
<p>With conda, you can create, export, list, remove, and update environments
<p>With conda, you can create, export, list, remove, and update environments
that have different versions of Python and/or packages installed in them. <br>
Switching or moving between environments is called activating the environment.
You can also share an environment file and import from <code>requirements.txt</code>.</p>
<p>💻 <code>conda env create -f environment.yml</code> Create conda environment <br>
💻 <code>activate py310</code> Activate environment <br>
💻 <code>python --version</code> Check python version</p>
<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">#</a></h2>
<p>In Python the <code>requirements.txt</code> file helps manage dependencies.
<p>In Python the <code>requirements.txt</code> file helps manage dependencies.
It's a text file that lists the packages that the Python project depends on.</p>
<p>💻 <code>pip install -r requirements.txt</code> Install from file</p>
<h2 id="pyproject">Pyproject<a class="headerlink" href="#pyproject" title="Permanent link">#</a></h2>
<p>This python package contains a <code>pyproject.toml</code> file that contains
build system requirements and information, which are
<a href="https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/">used by pip</a>
<p>This python package contains a <code>pyproject.toml</code> file that contains
build system requirements and information, which are
<a href="https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/">used by pip</a>
to build the package.
It contains the metadata of the software project.</p>
<div class="admonition note">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1230,9 +1230,9 @@ <h2 id="software-license">Software License<a class="headerlink" href="#software-
<a href="https://en.wikipedia.org/wiki/Open-source_license">open-source license</a>. <br>
The selected license can be read in the
<a href="https://github.com/rl-institut/super-repo/blob/production/LICENSE.txt">LICENSE.txt</a>.</p>
<p>This repository follows the <a href="https://reuse.software/">REUSE SOFTWARE</a>
specification.
All files are explicitly stating the corresponding license and copyright information.
<p>This repository follows the <a href="https://reuse.software/">REUSE SOFTWARE</a>
specification.
All files are explicitly stating the corresponding license and copyright information.
It is implemented as GitHub workflow and pre-commit hook:</p>
<ul>
<li>GitHub workflow: <a href="https://github.com/rl-institut/super-repo/blob/feature-7-REUSE/.github/workflows/reuse.yml">reuse.yml</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/development/collaboration/meeting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1210,7 +1210,7 @@ <h1 id="meetings">Meetings<a class="headerlink" href="#meetings" title="Permanen
<p>In order to develop a program collaboratively, it is helpful to regularly
exchange information about the current status and to discuss open questions
and make decisions. <br>
If you want to join the meetings, please use the
If you want to join the meetings, please use the
<a href="https://github.com/rl-institut/super-repo/discussions">GitHub Discussions</a>.</p>
<h2 id="developer-meetings">Developer Meetings<a class="headerlink" href="#developer-meetings" title="Permanent link">#</a></h2>
<p>In the regular developer meetings, the open issues and pull requests are
Expand Down
4 changes: 2 additions & 2 deletions develop/development/collaboration/users/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1133,8 +1133,8 @@


<h1 id="users">Users<a class="headerlink" href="#users" title="Permanent link">#</a></h1>
<p>Known user of this software can be added to
<a href="https://github.com/rl-institut/super-repo/blob/production/USERS.cff">USERS.cff</a>
<p>Known user of this software can be added to
<a href="https://github.com/rl-institut/super-repo/blob/production/USERS.cff">USERS.cff</a>
for reference.</p>


Expand Down
250 changes: 125 additions & 125 deletions develop/development/git/github-labels.json
Original file line number Diff line number Diff line change
@@ -1,127 +1,127 @@
[
{
"name": "other: example 📐",
"description": "Provides an example",
"color": "EBF0F3"
},
{
"name": "other: good first issue 🌱",
"description": "Good for newcomers",
"color": "EBF0F3"
},
{
"name": "other: help wanted 🙋",
"description": "Help or assistance is needed",
"color": "EBF0F3"
},
{
"name": "part: backend 🧱",
"description": "Backend component",
"color": "A7F3D5"
},
{
"name": "part: community 🌍",
"description": "Concerns the community",
"color": "A7F3D5"
},
{
"name": "part: docu 📖",
"description": "Improvements or additions to documentation",
"color": "A7F3D5"
},
{
"name": "part: frontend 🖥️",
"description": "Improvement of design or content",
"color": "A7F3D5"
},
{
"name": "part: github",
"description": "Improvement of the organisation or repo",
"color": "A7F3D5"
},
{
"name": "priority: critical 🔥",
"description": "Critical priority",
"color": "FCA5A5"
},
{
"name": "priority: high ⚡",
"description": "High priority",
"color": "FDBA74"
},
{
"name": "priority: low 🦥",
"description": "Low priority",
"color": "FCD34D"
},
{
"name": "resolution: duplicate 🐾",
"description": "This issue or pull request already exists",
"color": "ECDCF8"
},
{
"name": "resolution: invalid ❌",
"description": "Issue is invalid",
"color": "ECDCF8"
},
{
"name": "resolution: released 🎉",
"description": "Resolved and released",
"color": "ECDCF8"
},
{
"name": "resolution: wontfix ⛔",
"description": "This will not be worked on",
"color": "ECDCF8"
},
{
"name": "status: active 🚧",
"description": "Work in progress",
"color": "93C5FD"
},
{
"name": "status: blocked 🛑",
"description": "Blocked or impeded progress",
"color": "F9A8D4"
},
{
"name": "status: completed ✔️",
"description": "Task has been completed",
"color": "6EE7B7"
},
{
"name": "status: decision wanted 🗳️",
"description": "Decision is needed",
"color": "F9A8D4"
},
{
"name": "status: discussion 💬",
"description": "Discussion is ongoing",
"color": "93C5FD"
},
{
"name": "type: bug 🐛",
"description": "Something isn't working",
"color": "FEF1C7"
},
{
"name": "type: enhancement ⚙️",
"description": "Improvement of an existing feature",
"color": "FEF1C7"
},
{
"name": "type: feature 🛠️",
"description": "New feature or request",
"color": "FEF1C7"
},
{
"name": "type: question ❓",
"description": "Further information is requested",
"color": "FEF1C7"
},
{
"name": "type: release 🚀",
"description": "Release procedure",
"color": "FEF1C7"
}
{
"color": "EBF0F3",
"description": "Provides an example",
"name": "other: example \ud83d\udcd0"
},
{
"color": "EBF0F3",
"description": "Good for newcomers",
"name": "other: good first issue \ud83c\udf31"
},
{
"color": "EBF0F3",
"description": "Help or assistance is needed",
"name": "other: help wanted \ud83d\ude4b"
},
{
"color": "A7F3D5",
"description": "Backend component",
"name": "part: backend \ud83e\uddf1"
},
{
"color": "A7F3D5",
"description": "Concerns the community",
"name": "part: community \ud83c\udf0d"
},
{
"color": "A7F3D5",
"description": "Improvements or additions to documentation",
"name": "part: docu \ud83d\udcd6"
},
{
"color": "A7F3D5",
"description": "Improvement of design or content",
"name": "part: frontend \ud83d\udda5\ufe0f"
},
{
"color": "A7F3D5",
"description": "Improvement of the organisation or repo",
"name": "part: github"
},
{
"color": "FCA5A5",
"description": "Critical priority",
"name": "priority: critical \ud83d\udd25"
},
{
"color": "FDBA74",
"description": "High priority",
"name": "priority: high \u26a1"
},
{
"color": "FCD34D",
"description": "Low priority",
"name": "priority: low \ud83e\udda5"
},
{
"color": "ECDCF8",
"description": "This issue or pull request already exists",
"name": "resolution: duplicate \ud83d\udc3e"
},
{
"color": "ECDCF8",
"description": "Issue is invalid",
"name": "resolution: invalid \u274c"
},
{
"color": "ECDCF8",
"description": "Resolved and released",
"name": "resolution: released \ud83c\udf89"
},
{
"color": "ECDCF8",
"description": "This will not be worked on",
"name": "resolution: wontfix \u26d4"
},
{
"color": "93C5FD",
"description": "Work in progress",
"name": "status: active \ud83d\udea7"
},
{
"color": "F9A8D4",
"description": "Blocked or impeded progress",
"name": "status: blocked \ud83d\uded1"
},
{
"color": "6EE7B7",
"description": "Task has been completed",
"name": "status: completed \u2714\ufe0f"
},
{
"color": "F9A8D4",
"description": "Decision is needed",
"name": "status: decision wanted \ud83d\uddf3\ufe0f"
},
{
"color": "93C5FD",
"description": "Discussion is ongoing",
"name": "status: discussion \ud83d\udcac"
},
{
"color": "FEF1C7",
"description": "Something isn't working",
"name": "type: bug \ud83d\udc1b"
},
{
"color": "FEF1C7",
"description": "Improvement of an existing feature",
"name": "type: enhancement \u2699\ufe0f"
},
{
"color": "FEF1C7",
"description": "New feature or request",
"name": "type: feature \ud83d\udee0\ufe0f"
},
{
"color": "FEF1C7",
"description": "Further information is requested",
"name": "type: question \u2753"
},
{
"color": "FEF1C7",
"description": "Release procedure",
"name": "type: release \ud83d\ude80"
}
]
24 changes: 6 additions & 18 deletions develop/development/git/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1288,50 +1288,38 @@ <h2 id="github-labels">GitHub Labels<a class="headerlink" href="#github-labels"
Colours and emoticons improve presentation.</p>
<p>Categories:</p>
<ul>
<li><strong>type</strong>:<ul>
<li><strong>type</strong>:</li>
<li>bug :bug: "Something isn't working" [default] #FEF1C7</li>
<li>feature :hammer_and_wrench: "New feature or request" #FEF1C7</li>
<li>enhancement :gear: "Improvement of an existing feature" [default] #FEF1C7</li>
<li>question :question: "Further information is requested" [default] #FEF1C7</li>
<li>release :rocket: "Release procedure" #FEF1C7</li>
</ul>
</li>
<li><strong>part</strong>:<ul>
<li><strong>part</strong>:</li>
<li>backend :bricks: "Backend component" #A7F3D5</li>
<li>frontend :desktop_computer: "Improvement of design or content" #A7F3D5</li>
<li>docu :book: "Improvements or additions to documentation" [default] #A7F3D5</li>
<li>github :octocat: "Improvement of the organisation or repo" #A7F3D5</li>
<li>community :earth_africa: "Concerns the community" #A7F3D5</li>
</ul>
</li>
<li><strong>status</strong>:<ul>
<li><strong>status</strong>:</li>
<li>active :construction: "Work in progress" #93C5FD</li>
<li>discussion :speech_balloon: "Discussion is ongoing" #93C5FD</li>
<li>blocked :stop_sign: "Blocked or impeded progress" #F9A8D4v</li>
<li>decision wanted :ballot_box: "Decision is needed" #F9A8D4</li>
<li>completed :heavy_check_mark: "Task has been completed" #6EE7B7</li>
</ul>
</li>
<li><strong>priority</strong>:<ul>
<li><strong>priority</strong>:</li>
<li>low :sloth: "Low priority" #FCD34D</li>
<li>high :zap: "High priority" #FDBA74</li>
<li>critical :fire: "Critical priority" #FCA5A5</li>
</ul>
</li>
<li>resolution:<ul>
<li>resolution:</li>
<li>released :tada: "Resolved and released" #ECDCF8</li>
<li>wontfix :no_entry: "This will not be worked on" [default] #ECDCF8</li>
<li>invalid :x: "Issue is invalid" [default] #ECDCF8</li>
<li>duplicate :feet: "This issue or pull request already exists" [default] #ECDCF8</li>
</ul>
</li>
<li>other:<ul>
<li>other:</li>
<li>good first issue :seedling: "Good for newcomers" [default] #EBF0F3</li>
<li>help wanted :raising_hand: "Help or assistance is needed" [default] #EBF0F3</li>
<li>example :triangular_ruler: "Provides an example" #EBF0F3</li>
</ul>
</li>
</ul>
<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-repo/actions">GitHub Actions</a>
are used to automate processes of the repository. <br>
Expand Down

0 comments on commit d1cff39

Please sign in to comment.