初めに
Sphinxでのドキュメント生成はオリジナルで自動生成を行おうとする際にwaringが割と発生する。
特に一定期間触れないと忘れるので、対策後にまとめる。
したがって、新たに発生したら追記しようと思う。
WARNING: Title underline too short.
Title underline too short.
見出しに使用するテキストより、見出し指定を行うアンダーラインが短いと出るエラー。
[NG]
text
==
[OK]
text
========
WARNING: Field list ends without a blank line; unexpected unindent.
Field list ends without a blank line; unexpected unindent.
フィールドリスト（ブロック）や属性を設定するなどを示す区切り文字としてコロンが使用されている。
但し、コロンはソースコードの各行1文字目に置くことができない。
ただの文字としては空白を設けることでエラーを防げるが、元々のフィールドリストを記載したい場合はその記法に則った記載を行う。
[NG]
:
[OK]
:
WARNING: the following exception was raised
autodoc: failed to import function 'xxx_function' from module 'xxx_module'; the following exception was raised:
No module named 'xxx_module'
autodoc拡張を使用している場合において、moduleがルートディレクトリ内に存在しない。
ルート設定はしているが、moduleを認識できていない。
未解決。
最後に
追記した場合は以下に記載していく。