著者は、変更を確認するために、ローカルでPythonのドキュメントをビルドしてプレビューする方法を発見しました。 そのために、`make -C Doc venv htmllive` コマンドを使用しました。これは、ライブリロードも提供します。 著者は、concurrent.interpretersモジュールのドキュメントで、揃っていない「関連情報」コールアウトの視覚的な問題に遭遇しました。 問題は、インデントのため、ブロック引用として不正に整形されたコメントブロックに由来していました。 著者は、reStructuredText(rST)に不慣れだったため、根本的な原因を特定するのに苦労しました。 ある程度の調査の後、コメントから単一のスペースを削除することで問題が解決したことがわかりました。 著者はさらにドキュメントを改善し、文を大文字にし、ピリオドを追加しました。 これにより、「関連情報」セクションが大幅に改善され、初期の問題が解決されました。 ドキュメントをローカルでビルドしてプレビューすることは、問題を特定して解決するための効果的な方法でした。 著者は、改善された視覚的なプレゼンテーションに満足していました。
mathspp.com
Rodrigo Girão Serrão: TIL #135 – Build the Python documentation
Create attached notes ...
