これは https://ja.cppreference.com で運営されている C++ 標準ライブラリのリファレンスドキュメント Cppreference のためのソースパッケージです。 https://github.com/p12tic/cppreference-doc でメンテナンスされている英語版からフォークし、日本語版のために必要な変更を加えています。
このパッケージにサブディレクトリ reference/ が存在しない場合、実際のドキュメントはここには存在せず、バイナリパッケージをビルドするためにはそれを別個に取得しなければなりません。 これには以下の2つの方法があります。
-
準備済みのアーカイブを https://ja.cppreference.com/w/Cppreference:Archives からダウンロードする。 この方法が推奨されます。
-
make sourceを実行する。 これはドキュメントをページ単位で直接ウェブサイトから引っ張ります。 通常この方法を使用するべきではありません。 ダウンロードスクリプトは https://ja.cppreference.com/w/Cppreference:Archives に新しいリリースがあるときにのみウェブサイトの変更に対応するために更新されます。 最後のリリース以降にウェブサイトのレイアウトが変更されている場合、ダウンロードスクリプトは動作しないかもしれません。 また、これはサーバに余計な負荷をかけます。 自分が何をしようとしているのか解っていないのであれば、この方法は使用しないでください。
上記のドキュメントはウェブサイトの生のコピーであり、ローカルでの閲覧に適した形にするためには変換が必要です。 現在のところ3種類のドキュメント形式がサポートされています。
-
プレーンな HTML ドキュメント。
make doc_htmlで生成できます。 変換の結果はサブディレクトリ output/reference に配置されます。 -
Devhelp 形式。
make doc_devhelpで生成できます。make installでドキュメントが適切な位置にインストールされます。 -
Qt ヘルプ形式 (.qch)。
make doc_qchで生成できます。make installでドキュメントが適切な位置にインストールされます。
単純に make all を実行すると、3種類すべての形式のドキュメントが生成されます。
make release を実行すると、 https://ja.cppreference.com/w/Cppreference:Archives にアップロードされるリリースアーカイブが生成されます。
このパッケージはドキュメント生成のために wget (1.15以上)、 python3、 python3-lxml、および qhelpgenerator に依存しています。