Sphinx¶

簡単でインテリジェントで美しいドキュメントを作成

📝 リッチテキストフォーマット

reStructuredText または MyST Markdown でオーサリングすることで、表、強調表示されたコードブロック、数式表記など、高度に構造化された技術文書を作成できます。

🔗 強力な相互参照

プロジェクト内、さらには異なるプロジェクト間で相互参照を作成します。セクション、図、表、引用、用語集、コードオブジェクトなどへの参照を含めます。

📚 多様なドキュメント形式

HTML、LaTeX (PDF用)、ePub、Texinfo、その他を含む、オーディエンスが好む形式でドキュメントを生成します。

🎨 豊富なテーマサポート

組み込みおよびサードパーティのHTMLテーマの幅広い選択肢と、カスタマイズまたは新しいテーマを作成する機能により、視覚的に魅力的なドキュメントを作成します。

🔌 完全な拡張性

多数の組み込みおよびサードパーティ拡張機能を利用した、堅牢な拡張メカニズムを介して、カスタム機能を追加します。ダイアグラムの作成、コードのテストなどのタスクに利用できます。

🛠️ 自動APIドキュメント

Python、C++、およびその他のソフトウェアドメインのAPIドキュメントを、手動でまたはドキュメント文字列から自動的に生成し、最小限の労力でコードドキュメントを最新の状態に保ちます。

🌍 国際化 (i18n)

グローバルなオーディエンスにリーチするために、ドキュメントの翻訳を複数言語で追加します。

🌟 アクティブなコミュニティとサポート

多数のリソース、チュートリアル、フォーラム、および例を備えた、アクティブなコミュニティの恩恵を受けます。

以下で使用されています

Python¶

Linux Kernel¶

Project Jupyter¶

Sphinxのドキュメントのナビゲート方法については、以下をご覧ください。

こちらもご覧ください

Sphinxドキュメントの目次には、このサイトのページがすべてリストされています。

はじめに¶

これらのセクションでは、Sphinxを使い始めるための基本事項を説明しています。これには、独自のドキュメントを最初から作成および構築することが含まれます。

基本

ユーザーガイド¶

これらのセクションでは、さまざまなユースケースでSphinxを使用および拡張するためのさまざまなトピックを取り扱っています。これらは、さまざまなコンテキストでSphinxを使用するための包括的なガイドであり、Sphinxに関するより多くの知識を前提としています。Sphinxを初めて使用する場合は、はじめにから始めることをお勧めします。

コミュニティガイド¶

Sphinxはコミュニティによってサポートされており、誰からの貢献も歓迎します。以下のセクションは、Sphinxコミュニティへの参加と貢献を始めるのに役立ちます。

プロジェクトに貢献したい場合は、Sphinxコントリビューターガイドをご覧ください。

コミュニティ

リファレンスガイド¶

リファレンスドキュメントは、より完全でプログラム的な性質を持ち、すばやく参照できる情報のコレクションです。ユースケース主導のドキュメントが必要な場合は、はじめにまたはユーザーガイドをご覧ください。

リファレンス