README.rst

Schnelleinstieg

Status

Installation

1. Auschecken:

   $ git clone https://github.com/cusyio/ai-tutorial.git
   $ cd ai-tutorial

2. Installieren von Python-Paketen:

   $ uv sync --frozen

   Zum Erstellen der Dokumentations wird zusätzlich die Abhängigkeitsgruppe docs benötigt:

   $ uv sync --frozen --group docs

3. Erstellen der HTML-Dokumentation:

   Zum Erstellen der HTML-Dokumentation (inkl. Ausführung der Jupyter-Notebooks):

   $ uv run sphinx-build -b html docs docs/_build/html

   Das Ergebnis liegt in docs/_build/html/; die Startseite ist docs/_build/html/index.html.

   Note

   Für PDF- oder EPUB-Export wird ggf. pandoc benötigt (z. B. unter Debian/Ubuntu: sudo apt install pandoc).

4. Erstellen eines PDF:

   Für PDF wird eine LaTeX-Installation benötigt:

   … auf Debian/Ubuntu:

   $ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

   … auf macOS (MacTeX):

   $ brew install --cask mactex

   Anschließend:

   $ cd docs/
   $ make latexpdf

   Das PDF liegt in docs/_build/latex/AITutorial.pdf.

Folgt uns

• GitHub

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehlen wir euch, einen Fork unseres GitHub Repository zu erstellen und eure Änderungen dort zu machen.

Die Entwicklungsumgebung könnt ihr erstellen mit

$ uv sync --frozen --group dev

Bevor ihr Commits macht, überprüft, ob die pre-commit-Checks erfolgreich durchlaufen:

$ pre-commit install