ドキュメンテーションの構築とホスティングのためのツール#

現在、Pythonエコシステムでドキュメントを構築するための最も一般的なツールはSphinxです。 しかし、 mkdocs のようなツールを使っているメンテナもいます。 ドキュメンテーションにどのプラットフォームを使うかはあなた次第です!

このセクションでは、ドキュメントを作成するための一般的なツールとしてSphinxを紹介します。 ここでは、Sphinxのドキュメントを書くときに使用できる、myStやrSTを含むさまざまな構文オプションについて説明します。

また、ドキュメントをオンラインで公開する方法や、ドキュメントのウェブサイトを最適化するためのSphinxツールについてもお話します。