What is it ?¤
the answer is ...
docstring2pdf とは、コードとともにドキュメントを書くチームを支援し、
常にそのドキュメントを最新に保つためのプロジェクトである。
いざ Python を使い始めたはいいが、 コードを書いてばかり / データ分析するだけしてそのまま放置してしまい、 ドキュメントを書くという行為をサボっている組織は少なくない。
Python においては、その問題を解決しうる仕組みとして
docstring がある。
「コードとは別にドキュメントを書かねばならない…」からやがて億劫になるのであって、
それがソースコードとともに書くべきものとなれば、開発チームの意識は変わっていく――
docstring2pdf では、docstring からきれいで見やすい ＋ 検索もできる！
という静的ドキュメンテーションサイトの生成はもちろん、
その内容を PDF に出力して Google Drive にアップロードするところまでを実装した。
既存プロジェクトへの移植も、いくつかの設定ファイルをコピペするだけでよい。
ドキュメンテーションに悩むすべての組織に、ぜひとも導入を検討してもらいたい。