GitHub

Other Output Formats

デフォルトのネイティブHTML出力に加えて、Documenterはa built-in LaTeX-based PDF outputも提供します。追加の出力形式はプラグインパッケージを通じて提供されます。対応するパッケージがロードされると、出力形式はformatオプションを使用してmakedocsで指定できます。

PDF Output via LaTeX

makedocs は、format キーワードとして Documenter.LaTeX オブジェクトを渡すことで、PDF/LaTeX バックエンドを使用するように切り替えることができます:

using Documenter
makedocs(format = Documenter.LaTeX(), ...)

Documenterは次に、LaTeXを使用してドキュメントのPDFファイルを生成し、それを出力（build/）ディレクトリに配置します。

makedocs 引数 sitename は、tex ドキュメントの \title フィールドに使用され、ビルドがリリースタグ用である場合（つまり、"TRAVIS_TAG" 環境変数が設定されている場合）、バージョン番号がタイトルに追加されます。makedocs 引数 authors も指定する必要があり、これは tex ドキュメントの \authors フィールドに使用されます。

Known issue

makedocs 引数 pages が割り当てられていない場合、Documenter は内容なしで tex ドキュメントを生成します。 (#2132)

Compiling using natively installed latex

ドキュメントを構築するために必要なものは次のとおりです：

  • pdflatex と latexmk コマンドがインストールされ、Documenter に利用可能である必要があります。
  • minted LaTeX パッケージとそのバックエンドソースハイライター Pygments をインストールする必要があります。
  • 必要なフォントは DejaVu Sans and DejaVu Sans Mono がインストールされている必要があります。

Compiling using Tectonic

ドキュメントは、Tectonic LaTeXエンジンを使用して構築することもできます。PATHにtectonicが利用可能であるか、tectonicキーワードを使用してバイナリへのパスを提供する必要があります。

using Documenter

# Executable `tectonic` is present in `PATH`
makedocs(
    format = Documenter.LaTeX(platform="tectonic"),
    ...)

# The path to `tectonic` is provided by the tectonic_jll package
using tectonic_jll: tectonic
makedocs(
    format = Documenter.LaTeX(platform="tectonic", tectonic=tectonic()),
    ...)

Compiling using docker image

事前に構築された docker image を使用して .tex ファイルをコンパイルすることも可能です。このイメージには、上記のセクションで説明されている必要なインストールがすべて含まれています。イメージを使用するための唯一の要件は、docker がインストールされており、ビルダーが呼び出せる状態であることです。また、Documenter にデフォルトのネイティブインストールされた tex の代わりに docker イメージを使用するように指示する必要があります。これは LaTeX 指定子を使用して行います：

using Documenter
makedocs(
    format = Documenter.LaTeX(platform = "docker"),
    ...
)

Travisでドキュメントをビルドする場合は、追加する必要があります。

services:
  - docker

あなたの .travis.yml ファイルに。

Compiling to LaTeX only

.texファイルのみを保存し、PDFコンパイルをスキップする可能性があります。この目的のために、platform="none"キーワードを使用してください：

using Documenter
makedocs(
    format = Documenter.LaTeX(platform = "none"),
    ...
)

Custom LaTeX style

PDF/LaTeXバックエンドは、入力されたMarkdownファイルに基づいてTeXファイルを生成することによって機能します。生成されたPDFに対してより多くの制御が必要なユーザーや望むユーザーのために、生成されたTeXコードのセットアップ部分をカスタマイズすることが可能です。

Load custom packages

デフォルトでは、生成されたTeXファイルはdocumenter.styスタイルファイルを読み込み、いくつかのパッケージ（fontspec、amsmath、listings、minted、tabulary、graphicxなど）をロードし、その他TeXビルドを構成します。

ユーザーは、assets/ ソースディレクトリに custom.sty ファイルを追加することで、追加のパッケージをロードし、追加の設定を宣言できます。カスタムスタイルファイルは、デフォルトスタイル（documenter.sty）の直後にロードされます。

Custom preamble

デフォルトでは、Documenterは preamble.tex プレアンブルを使用し、その前に動的に生成された \DocMainTitle、\DocVersion、\DocAuthors、および \JuliaVersion 変数の宣言のみがあります。

より詳細な制御のために、assets/ ソースディレクトリに preamble.tex ファイルを追加することで、プレアンブルを完全に置き換えることが可能です。これにより、デフォルトのものの代わりに使用されます。Documenter テストには、カスタムプレアンブルの使用方法の2つの例が含まれています：

Markdown & MkDocs

DocumenterはもはやMarkdown/MkDocs出力を提供しておらず、この機能はDocumenterMarkdownパッケージに移動しました。