Skip to content

document

shimakaze-git edited this page Jan 21, 2022 · 1 revision

sphinx-apidoc

$ sphinx-apidoc -F -o ./docs ./sample
  • -F : fullで生成します。指定しない場合はrstファイルのみ生成されます
  • -f : 出力時に強制上書きをします
  • -o : 出力先を指定します
  • -H : プロジェクト名を指定します
  • -A : authorを指定します
  • -V : versionを指定します

sphinx-build

$ sphinx-build [options] [src] [dest] 
  • -b : ビルダー(≒出力形式)を指定します。デフォルトではhtmlですが、xml、latexなどを指定することができます。
  • -a : すべての出力ファイルを書き出します。このオプションをつけない場合は新規に作成されたり、変更のあったソースファイルに関連する出力ファイルだけを出力します。
Clone this wiki locally