1. Sphinxとは

Spihnxは、reStructuredText記法で書かれたテキストファイルをHTML、 PDFやepubなどの様々な形式へ変換するためのツールです。

Pythonの公式ドキュメントはSphinxを使って書かれています。 また、Python以外の多くのプロジェクトでもSphinxが利用されています。

1.2. Sphinxの処理の流れ

Sphinxでは、サンプルで見たreStructuredTextのファイルを、 読み込み変換することでhtmlやPDFなどを出力します。

/var/build/user_builds/planset-study-sphinx/checkouts/latest/docs/_build/html/blockdiag-332ef6c57a270533cd510c5b877d42d00ac52ee4.png
Read the Docs v: latest
Versions
latest
Downloads
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.