PyTorch など有名ライブラリは sphinx を利用していることが多い。
doxygen よりも良いと思う。色々とできるはず。

• nbsphinx とか使えば ipynb をより見やすい感じにできそう。
  • デバッグなどの様子を見せるのに使う

リポジトリにドキュメントを追加するときに何から始めるか。

以下のコマンドで対話が始まって自動で作成される。とりあえず build のディレクトリは分ける設定で良さそう？

sphinx-quickstart

実行したディレクトリを . とすると

- ./
    - ./build/            : gh-pages を別ブランチで公開するならこれごと .gitignore してよい。
      - ./build/doctrees  : .gitignore しても良い。ビルド時のキャッシュ
      - ./build/html      : gh-pages として公開すれば良いディレクトリ
    - ./source/
    - ./make.bat
    - ./Makefile

となった。

make html すればよい。

何を git 管理するべき？

build/html/ の中で python -m http.server すれば良い。
なので、 build/html/ さえ gh-pages で公開すれば良さそう。