💻

Pythonのドキュメント生成システムのpdocを使ってみた

1 min read

ドキュメントの自動生成といえばsphinxが一番有名ですが、構築などが少し難しいのでもっと簡単にできないかと考えていました
今回はPythonのドキュメント生成システムのpdocを使って、GitHub Pagesでドキュメントを公開する所までやってみます
今回のサンプルリポジトリは下記です

https://github.com/KazukiNoto/pdoc

インストール

インストール

pip install pdoc3

プログラムのとDocstringでコメントを書く

プログラムとDocstring形式でコメントを書いていきます

ドキュメントの生成

pdoc hogehoge --html -o docs --force

上のコマンドでは、docsディレクトリにhogehogeのドキュメントを生成していますので、docsディレクトリにHTMLファイルができています。

GitHub Pagesでドキュメント公開

GitHub Pagesを使ってドキュメントを公開したい場合は、docsディレクトリにしておくと、GitHub Pagesの設定で簡単にページを公開することができます

こんな感じで特に何もすることなくドキュメントが公開されます。

Discussion

ログインするとコメントできます