Update documentation and changelog #61

CHANGELOG.md

@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add first version of pyproject.toml [(#64)](https://github.com/rl-institut/super-repo/pull/64)
 - Add documentation for code style [(#63)](https://github.com/rl-institut/super-repo/pull/63)
 - Update REUSE [(#66)](https://github.com/rl-institut/super-repo/pull/66)
+- Add workflow with codecov [(#68)](https://github.com/rl-institut/super-repo/pull/68)
 
 ### Changed
 

docs/development/documentation/index.md

@@ -36,19 +36,17 @@ Generate the documentation locally. <br>
 Publish documentation on **GitHub Pages**. <br>
 💻 `mkdocs gh-deploy` manually deploys the documentation files
 
-#### GitHub Action (deprecated)
+!!! warning "Manually deploy documentation"
+    This command overrides all manually deployed versions (mike). <br>
+
+#### GitHub Action
 
 🐙 Deploy the documentation with **GitHub Actions**. <br>
-The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow. <br>
+The file `.github\workflows\documentation.yml` creates an automated GitHub workflow. <br>
 It is configured to be pushed to the branch `gh-page` and then deployed online. <br>
-A commit on the `production` branch triggers the workflow.
-
-!!! warning "Using mike with GitHub Actions"
-    This feature is not compatible with the versioning of the documentation with `mike`! <br>
-    The action overrides all manually deployed versions. <br>
-    🐙 To disable an existing `GitHub Action`, follow [these instructions](https://docs.github.com/de/enterprise-cloud@latest/actions/using-workflows/disabling-and-enabling-a-workflow).
+A commit on the `develop` branch starts the workflow.
 
-### Mike
+#### Mike
 
 The package [mike](https://github.com/jimporter/mike) is used to deploy [multiple versions](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=versioning) of the documentation.<br>
 💻 `pip install mike` install mike <br>

docs/development/git/index.md

@@ -20,7 +20,7 @@ The majority of the development will be done in `feature` branches.
 
 ## Gitignore
 
-This file specifies intentionally untracked files to ignore.
+This file specifies intentionally untracked files to ignore. <br>
 It is copied from [a collection of .gitignore templates](https://github.com/github/gitignore). <br>
 For more information about how `.gitignore` files work, see the [Ignoring Files chapter](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) of the Pro Git book.
 
@@ -46,6 +46,7 @@ GitHub Labels are used to organize Issues and PR. <br>
 Colours and emoticons improve presentation.
 
 Categories:
+
 - **type**:
     - bug :bug: "Something isn't working" [default] #FEF1C7
     - feature :hammer_and_wrench: "New feature or request" #FEF1C7

mkdocs.yml

@@ -75,11 +75,8 @@ nav:
       - Code of Conduct: development/collaboration/code_of_conduct.md
     - Git:
       - development/git/index.md
-      - Gitignore: development/git/gitignore.md
-      - Pre-commit: development/git/pre-commit.md
     - Continuous Integration:
       - development/continuous-integration/index.md
-      - Test-Driven-Development: development/best-practice/test-driven-development-workflow.md
     - Documentation:
       - development/documentation/index.md
     - Release:

tests/__init__.py

@@ -2,6 +2,7 @@
 
 """Example.
 
+Examples test for the calculater functionality to demonstrate TDD.
 
 SPDX-FileCopyrightText: Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
 SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut