Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ドキュメントのビルド

この章では、標準ライブラリ(std)やコンパイラ(rustc)など、 ツールチェーンコンポーネントのドキュメントをビルドする方法について説明します。

  • すべてをドキュメント化する

    これは beta ツールチェーンの rustdoc を使用するため、 stage 1 rustdoc とは(わずかに)異なる出力が生成されます。 rustdoc は活発に開発されているためです。

    ./x doc
    

    ドキュメントが CI 上と同じように見えることを確実にしたい場合は、次のようにします。

    ./x doc --stage 1
    

    これにより、(現在の)rustdoc がビルドされ、 その後、それを使用してコンポーネントがドキュメント化されます。

  • 個別のテストを実行したり、特定のコンポーネントをビルドしたりする場合とほぼ同様に、 必要なドキュメントだけをビルドできます。

    ./x doc src/doc/book
    ./x doc src/doc/nomicon
    ./x doc compiler library
    

    ブックの完全な一覧については、nightly ドキュメントのインデックスページを参照してください。

  • rustc の内部項目をドキュメント化する

    コンパイラのドキュメントはデフォルトではビルドされません。 x doc でデフォルトで作成するには、bootstrap.toml を変更します。

    build.compiler-docs = true
    

    有効にすると、内部コンパイラ項目のドキュメントもビルドされることに注意してください。

    注: コンパイラのドキュメントはこちらのリンクにあります。