SphinxとRead the DocsによるPythonドキュメント作成

クリーンなコードを書くことは戦いの半分に過ぎません。明確なドキュメントがなければ、どんなに優れたPythonプロジェクトであっても、使われず誤解されたままになってしまいます。このテキストベースのコースでは、プロジェクトのドキュメントをゼロから作成、構成、維持するプロセスをガイドします。ドキュメントのないコードから、完全に自動化された最新のドキュメントポータルを構築する段階へと進みます。docstringの抽出方法、ユーザーガイドの構成方法、そしてリポジトリを更新するたびにドキュメントを自動的にWebへデプロイする方法を理解できます。学習内容: Sphinx、reStructuredText、および最新のパーサーを使用したMarkdown統合のコアコンセプトを理解する; Sphinxプロジェクトをゼロから構成し、レイアウト、テーマ、設定をカスタマイズする; GoogleおよびNumPyフォーマットスタイルを使用して、PythonのdocstringからAPIドキュメントを自動生成する; doctestを使用してドキュメントに自動テストを統合し、コード例が常に最新であることを保証する; コードリポジトリをRead the Docsに接続し、ドキュメントの自動継続的デプロイを実現する; ユーザーガイド、FAQ、開発者向けインストールマニュアルを構成するためのベストプラクティスを適用する。このコースは、ドキュメントマークアップの基礎概念から始まり、実践的なSphinxの設定へと進みます。その後、高度なdocstring抽出、自動テスト、クラウドデプロイパイプラインへとステップアップします。本コースは、プロジェクトのドキュメントを改善したいあらゆるレベルのPython開発者を対象としています。Sphinxやテクニカルライティングの事前経験は不要ですが、PythonとGitの基本的な知識があると役立ちます。今すぐ読み始めて、Pythonコードベースをドキュメントが整備されたプロフェッショナルなプロジェクトに変えましょう。