Sphinx でドキュメントに README を含める

Posted on Sat 16 November 2019 in misc • Tagged with sphinx

Django でアプリケーションをつくろうと思っています。自分ひとりで開発するとは言え、ドキュメントがまったく無いのでは開発できないと思い、Sphinx でドキュメントを書き始めました。

ドキュメントは書くし、README も必要だし、同じような内容を両方に書かなければならないのか? Sphinx でドキュメントに README.rst を挿入できないか?

簡単でした。 README.rst を挿入したいところで include ディレクティブを使うだけ。

.. include:: ../../README.rst

Continue reading