そろそろドキュメントを書き始めることにした
そろそろドキュメントを書き始めることにした。ただまだまだ個人用のつもりなのでまともな文章は書かない。
どうしてドキュメントがほしくなったか？
どうしてドキュメントが欲しくなったかというと、このはてなブログの記事だけでは断片的な情報になってしまいあとで探すのが面倒になったため。 もう少しいうと、ずっと作っていたリポジトリについて頭の中に入れておくのが面倒くさくなったため。使い方などを外部に出力して忘れてしまいたい。
欲しいドキュメント
APIドキュメントが欲しくなったことがあまり無いのでいらない。欲しいのは用例だけ。
ここに作り始めた
まだまだ書き足していないし。文章がない。
readthedocs
とりあえず、pythonだし、readthedocsを使うことにした。sphinxを入れるのも久しぶりだし。実はreadthedocsでまじめに(まじめに?)ドキュメントを作るのははじめてだった。
何となくmarkdownが使える様になったらしいのでmarkdownを使うことにした。この辺を参考にした。
sphinxのテーマ
デフォルトのalabasterのままそんなにページ数が多くないのでsidebarを取り払った。サブページからトップページへのリンクがなくなってしまったのはちょっと不便。
追記
すぐにmarkdownを諦めた。literalincludeが使いたくなった。
