Quellcode
Quellcode-Repository für diese Dokumentation.
Dokumentation erstellen
Um diese Dokumentation lokal zu erstellen, führen Sie die folgenden Schritte aus.
Installieren von Abhängigkeiten
Installieren Sie Abhängigkeiten, wie bei Debian:
sudo apt update
sudo apt install python-is-python3 python3-pip python3-venv
Dokumentation herunterladen Quelle
git clone https://spacecruft.org/aviation/aircraft-moe
cd aircraft-moe/
Python einrichten
python -m venv venv
source venv/bin/activate
pip install -U pip poetry
poetry install
poetry update
Hilfe
Führen Sie zum Anzeigen von Build-Hilfen Folgendes aus:
make help
Dies wird diese Hilfe anzeigen:
Please use 'make <target>' where <target> is one of
clean Remove all build files and directories (including translations)
all Clean and make all targets
gettext_build Build localisation strings for translation
update_locale Update localisation
update_locale_<lang> Update localisation for <lang>
html Build the HTML documentation for all languages
html_<lang> Build HTML documentation for <lang>
latex Build the documentation using LaTeX for all languages
latex_<lang> Build the documentation using LaTeX for <lang>
pdf Build the PDF documentation using LaTeX for all languages
pdf_<lang> Build the PDF documentation using LaTeX for <lang>
ebook Reduce size of PDF for eBook
prepress Reduce size of PDF for prepess
index Copy static docs/index.html to docs/_build/html/index.html
translations Translate from English
Reinigen
Reinigen Sie die Build-Artefakte auf diese Weise.
make clean
HTML-Dokumentation erstellen
Führen Sie zum Erstellen der HTML-Dokumentation den Befehl aus:
make index
make html
Die resultierende HTML-Datei befindet sich in docs/_build/html/
mit einer Datei auf oberster Ebene index.html
, die sich hier befindet: docs/index.html
.
LaTeX-PDF erstellen
Um ein PDF-Dokument aus einem LaTeX-Build zu erstellen, installieren Sie zuerst die Abhängigkeiten (das ist viel mehr als nötig):
sudo apt install texlive-full jabref
Erstellen Sie dann die LaTeX- und PDF-Dokumente:
make latex
Die resultierende PDF-Datei wird hier gespeichert: docs/_build/latex/de/zenithstolch750superdutybuild.pdf
.
PDF erstellen
So erstellen Sie ein PDF-Dokument aus LaTeX:
make pdf
Die resultierende PDF-Datei wird hier gespeichert: docs/_build/latex/de/zenithstolch750superdutybuild.pdf
.
eBook
Um die PDF-Datei für ein eBook auf 150 dpi zu verkleinern, führen Sie Folgendes aus:
make ebook
Die resultierende PDF-Datei wird hier gespeichert: docs/_build/latex/de/zenithstolch750superdutybuild-ebook.pdf
.
Druckvorstufe
Um die PDF-Datei für den Druck auf 300 dpi zu verkleinern, führen Sie Folgendes aus:
make prepress
Die resultierende PDF-Datei wird hier gespeichert: docs/_build/latex/de/zenithstolch750superdutybuild-prepress.pdf
.
Alles bauen
Um alles zu erstellen, einschließlich HTML und PDFs.
make all
Literaturverzeichnis
Die Bibliographie kann mit jabref
bearbeitet werden, z. B.:
jabref docs/_source/aircraft-moe.bib