ソースコード
このドキュメントのソースコードリポジトリ。
ドキュメントの構築
このドキュメントをローカルで構築するには、次のようにします。
依存関係のインストール
依存関係をインストールします。 Debianの場合:
sudo apt update
sudo apt install python-is-python3 python3-pip python3-venv
ドキュメントのソースをダウンロード
git clone https://spacecruft.org/aviation/aircraft-moe
cd aircraft-moe/
Pythonのセットアップ
python -m venv venv
source venv/bin/activate
pip install -U pip poetry
poetry install
poetry update
ヘルプ
ビルドのヘルプについては、以下を実行してください:
make help
このヘルプを表示します:
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
クリーン
このようにして、ビルド成果物をクリーンにします。
make clean
HTML ドキュメントの構築
HTML ドキュメントを構築するには、以下を実行します:
make index
make html
生成されたHTMLは``docs/_build/html/``に置かれ、トップレベルの``index.html``ファイルは``docs/index.html``にあります。
LaTex PDFをビルド
LaTeXビルドからPDFドキュメントを構築するには、まず依存関係をインストールします(これは必要なものよりはるかに多いです)。
sudo apt install texlive-full jabref
LaTeXとPDFのドキュメントをビルドします:
make latex
生成されたPDFは、``docs/_build/latex/en/zenithstolch750superdutybuild.pdf``にあります。
PDFを作成
LaTeXからPDFドキュメントを作成するには:
make pdf
生成されたPDFは、``docs/_build/latex/en/zenithstolch750superdutybuild.pdf``にあります。
電子ブック
電子ブック用にPDFのサイズを150 dpiに大幅に縮小するには、次を実行します。
make ebook
生成されたPDFは、``docs/_build/latex/en/zenithstolch750superdutybuild-ebook.pdf``にあります。
プリプレス
印刷用にPDFのサイズを300dpiに縮小するには、次を実行します。
make prepress
生成されたPDFは、``docs/_build/latex/en/zenithstolch750superdutybuild-prepress.pdf``にあります。
すべてを構築する
HTMLとPDFを含むすべてを構築します。
make all
参考文献
参考文献は jabref
で編集できます。例えば:
jabref docs/_source/aircraft-moe.bib