19 Pakete und HTML-Dokumentation
Ein Modul ist eine einzelne Python-Datei (.py), die Funktionen, Klassen oder Variablen enthält. Module helfen, Code logisch zu gliedern und wiederverwendbar zu machen.
Beispiel für ein Modul math_utils.py:
# math_utils.py
def add(a, b):
return a + b
def multiply(a, b):
return a * b
Dieses Modul kann in anderen Dateien importiert werden:
import math_utils
print(math_utils.add(2, 3)) # Ausgabe: 5
print(math_utils.multiply(4, 5)) # Ausgabe: 20
Ein Paket ist ein Verzeichnis, das mehrere Module enthält und eine __init__.py-Datei besitzt. Diese Datei kennzeichnet das Verzeichnis als Paket.
Beispielstruktur:
my_package/
├── __init__.py
├── math_utils.py
└── string_utils.py
Inhalt von __init__.py (kann leer sein oder Exporte definieren):
from .math_utils import add, multiply
from .string_utils import capitalize
Verwendung des Pakets:
import my_package
print(my_package.add(2, 2))
MkDocs ist ein Werkzeug zur Erstellung von Webseiten für Projektdokumentation. Es nutzt Markdown-Dateien als Inhalt und erzeugt daraus eine statische HTML-Seite.
MkDocs wird mit pip installiert:
pip install mkdocs
Optional kann ein Theme wie material installiert werden:
pip install mkdocs-material
Erzeuge ein neues Dokumentationsprojekt:
mkdocs new my-docs
cd my-docs
Projektstruktur:
my-docs/
├── docs/
│ └── index.md
└── mkdocs.yml
Markdown-Dateien kommen ins docs/-Verzeichnis. Beispiel docs/index.md:
# Willkommen
Dies ist die Dokumentation zu meinem Projekt.
Starte einen lokalen Server zum Testen der HTML-Seite:
mkdocs serve
Die Seite ist nun unter http://127.0.0.1:8000/ erreichbar.
Zum Erzeugen der HTML-Seite verwende:
mkdocs build
Die fertige Seite befindet sich im Verzeichnis site/.
MkDocs unterstützt einfache Veröffentlichung mit GitHub Pages:
mkdocs gh-deploy
Das setzt voraus, dass dein Projekt in einem Git-Repository liegt.