✏️ Fix typos and formatting

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly

.github/workflows/ci.yml

@@ -22,10 +22,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+    - uses: pandoc/actions/setup@v1
     - uses: actions/setup-python@v5
       with:
         # Keep in sync with .readthedocs.yaml
         python-version-file: .python-version
+    - name: Install plantuml
+      run: |
+        sudo apt install plantuml
     - name: Setup cached uv
       uses: hynek/setup-cached-uv@v2
     - name: Create venv and install docs dependencies

.pre-commit-config.yaml

@@ -19,25 +19,25 @@ repos:
     - id: sphinx-lint
       types: [rst]
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
     - id: isort
       additional_dependencies: ["toml"]
       entry: isort --profile=black
       name: isort (python)
   - repo: https://github.com/psf/black
-    rev: 24.10.0
+    rev: 25.1.0
     hooks:
     - id: black
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: "1.19.0"
+    rev: "1.19.1"
     hooks:
     - id: blacken-docs
       args: [--line-length=79]
       additional_dependencies:
       - black
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
     - id: codespell
   - repo: local

CHANGELOG.rst

@@ -1,55 +1,199 @@
 Changelog
 =========
 
-The versions follow `Semantic Versioning <https://semver.org/lang/de/>`_:
-``MAJOR.MINOR.PATCH``.
+Alle nennenswerten Änderungen an diesem Projekt werden in dieser Datei
+dokumentiert.
 
-``MAJOR``
-     is increased when incompatible changes are published.
-``MINOR``
-    is increased when new compatible functionalities are released.
-``PATCH``
-    is increased if the changes include only compatible bug fixes.
+Das Format basiert auf `Keep a Changelog
+<https://keepachangelog.com/en/1.0.0/>`_ und dieses Projekt hält sich an
+`Calendar Versioning <https://calver.org>`_.
 
-.. _changelog
+Die erste Zahl der Version ist das Jahr. Die zweite Zahl wird mit jeder Version
+erhöht, beginnend bei 1 für jedes Jahr. Die dritte Zahl ist für Notfälle, wenn
+wir Zweige für ältere Versionen starten müssen.
 
-24.2.0
+.. unreleased
+
+`Unreleased <https://github.com/veit/python-basics-tutorial-de/compare/25.1.0...HEAD>`_
+---------------------------------------------------------------------------------------
+
+`25.1.0 <https://github.com/veit/python-basics-tutorial-de/compare/24.3.0...25.1.0>`_
+-------------------------------------------------------------------------------------
+
+Added
+~~~~~
+
+* 📝 Add type hints
+* 👥 Add license and acknowledgement
+* 📝 Add logging section from Python4DataScience
+* 🔧 📝 Add social media support
+
+  * Add OpenGraph tag for mastodon
+  * Add social media links
+
+* 📝 Add PyPI digital attestations
+* 📝 Add tip for a stride of -1
+* 📝 Add What’s new?
+* 📝 Add conversion to reST
+
+Changed
+~~~~~~~
+
+* 📝 Update cookiecutter templates
+
+  * Add badges
+  * Remove deprecated templates
+  * Add Jupyter Notebook section
+
+* 📝  Update glossary
+
+  * Add constant, singleton and immutable objects
+
+* 📝 Update uv sections
+
+  * Reproducing and updating uv environments
+
+* 🎨 Rearrange glossaries
+* 📝 Update conda term
+* 📝 Update GitLab package registry
+* 📝 Expand the pytest plugins section
+* 📝 Rearrange functions section
+* 📝 Update installation of freethreaded Python
+* 📝 Expand the contextmanager section
+* 🎨 Restructure the documentation
+
+  * Move packages outside libraries
+  * Move apps in packages
+  * Remove unittest2
+  * Move doctests to Sphinx
+  * Move the sqlite database test to unittest
+  * Move Sphinx to a subchapter
+
+Removed
+~~~~~~~
+
+* Remove OOP design
+
+`24.3.0 <https://github.com/veit/python-basics-tutorial-de/compare/24.2.0...24.3.0>`_
+-------------------------------------------------------------------------------------
+
+Added
+~~~~~
+
+* 📝 Add humanize
+* 📝 Add testing code to documentation
+* 📝 Add bump-my-version
+* 📝 Add vale
+* 📝 Add codespell
+* 📝 Add checks
+* 📝 Add LBYL and EAFP to exceptions
+* 📝 Add the series of tutorials and trainings
+* 📝 Adopt SOLID principles from Python4DataScience
+
+Changed
+~~~~~~~
+
+* 📝 Update description for init files
+* 📝 Update pytest plugins
+
+  * Add pytest-freethreaded to plugins for modified test sequences
+  * Add pytest-edit to modified output plugins
+  * Add playwright and pyleniumio to web dev plugins
+  * Add pytest-patterns to various plugins
+  * Remove pytest-splinter, pytest-mimesis and pytest-freezegun
+
+* 📝 Switch to uv for building envs, packaging etc.
+
+  * Install different Python versions in parallel including PyPy and
+    free-threaded Python 3.13.
+  * Add tox-uv
+  * Publishing packages
+  * Update uv.lock file with a pre-commit hook
+
+* 📝 Update cibuildwheel
+* 👷 Switch to uv in ci
+* 📝 Switch to .venv directory
+* 📝 Update to Python 3.13
+* 🔧 Switch to pyproject.toml
+* 📝 Rearrange documentation tests
+* 📝 Extend documentation of the string type
+* 📝 Extend documentation of the tuple type
+* 📝 Extend documentation of the list type
+* 📝 Add sphinx-issues
+* 📝 Add direnv tip
+* 📝 Update instructions for installing packages
+* 📝 Add proxy config for PyPI
+
+Fixed
+~~~~~
+
+* 📝 Fix coverage pipeline
+* ✏️ Workaround for pytest lexer warnings
+
+`24.2.0 <https://github.com/veit/python-basics-tutorial-de/compare/24.1.0...24.2.0>`_
+-------------------------------------------------------------------------------------
+
+Added
+~~~~~
 
-* 📝 Update Python on mobile devices
 * 📝 Add design patterns
-* 📝 Update Tiobe Index
 * 📝 Add frozenset
 * 📝 Add git filter for pytest
 * 📝 Add interrogate for docstring coverage
+
+Changed
+~~~~~~~
+
+* 📝 Update Python on mobile devices
+* 📝 Update Tiobe Index
 * 📝 Expand section for testing the documentation
 
-24.1.0
+`24.1.0 <https://github.com/veit/python-basics-tutorial-de/compare/v1.0.0...24.1.0>`_
+-------------------------------------------------------------------------------------
+
+Added
+~~~~~
 
 * 🌱 Add matplotlib for social cards
-* 🔧 Use git tag for versioning the docs
 * 📝 Add links for strftime
+* 📝 Add link to dataclasses
+* 📝 Add exclude_also to coverage configs
+
+Changed
+~~~~~~~
+
+* 🔧 Use git tag for versioning the docs
 * 📝 Update None type
 * 📝 Update the review of values and identity
 * 📝 Update comparative expressions
 * 📝 Update dataprep example
-* 🎨 pre-commit fixes
-* 📝 Add link to dataclasses
-* 📝 Update publishining gpackages
+* 📝 Update publishining packages
 
   * Add trusted publisher
 
-* 📝 Add exclude_also to coverage configs
+Fixed
+~~~~~
+
+* 🎨 pre-commit fixes
+
+`v1.0.0 <https://github.com/veit/python-basics-tutorial-de/commit/550a5202cd0c3055dea6d027083f99678d149228>`_: 2023-11-28
+-------------------------------------------------------------------------------------------------------------------------
+
+Added
+~~~~~
 
-1.0.0
+* 📝 Add dataclasses
+* 📝 Add striding and link to slicing with pandas
+* 📝 Add lambda functions
+
+Changed
+~~~~~~~
 
 * 🔖 Update to 1.0.0, add changelog
 * 💄 Switch to furo theme
-* 📝 Add dataclasses
 * 📝 Switch to intersphinx links
 * 📝 Add note to Unicode help
 * 📝 Add link to pandas I/O tools and examples for serialisation files
-* 📝 Add striding and link to slicing with pandas
-* 📝 Add lambda functions
 * 📝 Update dicts type
 
   * Add setdefault

README.rst

@@ -117,7 +117,13 @@ Installation
 Folgt uns
 ---------
 
+.. _follow-us:
+
 * `GitHub <https://github.com/veit/python-basics-tutorial-de>`_
+* `Mastodon <https://mastodon.social/@Python4DataScience>`_
+* `Bluesky <https://bsky.app/profile/python4data.science>`_
+
+.. _end-follow-us:
 
 Pull-Requests
 -------------

docs/_static/css/cusy.css

@@ -0,0 +1,12 @@
+.accelerator {
+  text-decoration: underline;
+}
+
+.field-list dt,
+.option-list dt,
+dl.footnote dt,
+dl.glossary dt,
+dl.simple dt,
+dl:not([class]) dt {
+  font-weight: 700;
+}