今日のみんなのPython勉強会 #58 で紹介されたツール。
startpython.connpass.com
ドキュメントの自動生成（整形）は昔から興味だけあっていろいろかじってるので、早速手を出してみる。
概要 — Sphinx 4.0.0+/ba93a41a7 ドキュメント
とりあえず、インストール。
Anaconda を使ってるので
conda install Sphinx
とやってみるといろいろまとめてインストールされて使えるようになった模様。
とりあえず適当に作った作業ディレクトリの中でお試しでコマンドをたたく。
sphinx-quickstart
いくつか聞かれるので適当に入れる。
言語を聞かれたので提示された下記urlを見て日本語を選択。
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language
- ja – Japanese
出来上がったファイルを見ると make があるので試しに
./make html
とやると、_build ディレクトリの中に html ディレクトリが出来てて、中の index.html を開くとちゃんとウェブページが表示された。
あとは中身を書くだけだな。
と言うとこまでで止まってるツールがいろいろ、、、
