Sphinxをはじめよう 第3版

1章Sphinxとは

Sphinx（スフィンクス）は、あるルールに従って記述されたテキストファイルを、HTMLやPDFなどの形式に変換するドキュメント変換ツールです。Sphinxはそれぞれの形式に変換する際、目次や相互参照などのナビゲーションを追加し、読みやすくレイアウトも行います。

本章では、Sphinxをどのようなドキュメントに使うのか、Sphinxとはどのようなソフトウェアなのか、その特徴と概要を紹介します。また、Sphinxと比較される他のツールとの違いについても紹介します。

1.1　Sphinxを何に使うのか

Sphinxは、もともとPython 1 の公式ドキュメントを作成するツールとして開発されました。2007年当時、Pythonのドキュメントは組版システムであるLaTeXで書かれていました。LaTeXは高品質なドキュメントの作成には定評があるものの、複雑なマクロを覚える必要があるなどのハードルがあり、ドキュメントを更新したいと言い出すユーザが少なかったようです。そこでGeorg Brandl（ゲオルグ・ブランドル）が、ドキュメントを更新しやすく、より使いやすいツールを目指してSphinxを開発しました。その際、GeorgはSphinxで用いるマークアップ言語としてreStructuredText（以下、reST 2 ）を採用しました 3 。reSTはシンプルで読みやすく、拡張性のあるマークアップ言語です。 その後、SphinxはPythonのライブラリやツール用のドキュメントだけでなく、RubyやPHPなど言語を問わず利用されるようになりました。最近では、プログラミングと関係のない分野でも広く利用されています。

Sphinxはひとつのソースから、HTMLだけでなく、PDFやEPUBなど、さまざまな形式のドキュメントを出力できます。そのため、目的に合った形式のドキュメントが得られます ...