ドキュメントのビルド
この章では、標準ライブラリ(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有効にすると、内部コンパイラ項目のドキュメントもビルドされることに注意してください。
注: コンパイラのドキュメントはこちらのリンクにあります。