Schnelleinstieg

1. Herunterladen und auspacken:

   … auf Linux/macOS:

   $ curl -O https://codeload.github.com/veit/python-basics-tutorial-de/zip/main
   $ unzip main
   Archive:  main
   …
      creating: python-basics-tutorial-de-main/
   …

   … auf Windows:

   C:> curl.exe -o main.zip -O https://codeload.github.com/veit/python-basics-tutorial-de/zip/main
   C:> tar -xvzf main.zip
   python-basics-tutorial-de-main/
   python-basics-tutorial-de-main/.gitignore
   python-basics-tutorial-de-main/.pyup.yml
   …
   

2. Installieren von Python-Paketen:

   … auf Linux/macOS:

   $ python3 -m venv .
   $ bin/python -m pip install --upgrade pip
   $ bin/python -m pip install -r docs/requirements.txt

   … auf Windows:

   C:> python -m venv .
   C:> Scripts\python -m pip install --upgrade pip
   C:> Scripts\python -m pip install -r docs/requirements.txt
   

3. Erstellen der HTML-Dokumentation:

   Note

   pandoc und plantuml müssen installiert sein.

   … auf Debian/Ubuntu:

   $  sudo apt install pandoc plantuml

   Zum Erstellen der HTML-Dokumentation führt den folgenden Befehl aus:

   $ sphinx-build -ab html docs/ docs/_build/html/

4. Erstellen eines PDF:

   Zum Erstellen einer PDF-Dokumentation benötigt ihr zusätzliche Pakete, die ihr installieren könnt

   … auf Debian/Ubuntu mit

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

   … auf macOS mit

   $ brew cask install mactex
   …
   🍺  mactex was successfully installed!
   $ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts
   $ sudo texlua install-getnonfreefonts
   …
   mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...
   mktexlsr: Done.

   Anschließend könnt ihr ein PDF generieren mit:

   $ cd docs/
   $ make latexpdf
   …
   The LaTeX files are in _build/latex.
   Run 'make' in that directory to run these through (pdf)latex
   …

   Das PDF findet ihr dann in docs/_build/latex/pythonbasics.pdf.

• GitHub

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehle ich euch, einen Fork meines GitHub Repository zu machen und eure Änderungen hier zu machen. Ihr könnt auch gerne einen pull request stellen. Wenn die dort enthaltenen Änderungen klein und atomar sind, werde ich mir eure Vorschläge gerne anschauen.