最初のプロジェクトを構築する¶
このチュートリアルでは、Sphinx を使用して簡単なドキュメントプロジェクトを構築し、HTML としてブラウザに表示します。このプロジェクトには、ナラティブ、手書きのドキュメント、および自動生成された API ドキュメントが含まれます。
このチュートリアルは、プロジェクトの作成と構造化の基本を学びたい Sphinx 初心者向けです。一貫したドキュメント化を目的としたガイドとして役立てる、架空のソフトウェアライブラリを作成し、ランダムなレシピを生成します。
コードドキュメントの Sphinx の機能を披露するために、Python を使用します。これは自動ドキュメント生成もサポートしています。
注意
Sphinx には、手動コードドキュメント用にネイティブでサポートされている他の言語が多数ありますが、自動コードドキュメントには Breathe などの拡張機能が必要です。
指示に従うには、Linux 風のコマンドラインへのアクセス、およびその仕組みの基礎的な理解が必要です。また、プロジェクトを作成するためにPython 仮想環境を使用するため、開発用の動作する Python インストールも必要です。