Sphinxって何？¶

Sphinxとはどういうもの？¶

ユーザー会 のページが参考になります。

reStructuredTextという軽量マークアップ言語を使ったドキュメント作成ツールです。

WordのようなWYSIWYG（出来映えを見ながら入力する）タイプのものではなく、reStructuredTextという書式に則ったテキストファイルを作って、それをコンバータのような変換プログラムを使ってHTMLとかPDFとかに変換します。

原稿がテキストファイルですので、大きなドキュメントを作ったときにファイルがクラッシュしたなんてことが防げます。

また、原稿がテキストファイルですので、再利用が割と容易です。

当サイトでは、Windows環境下でのSphinxの利用について書いていきます。

何が良いの？¶

文書を作成するには、いろいろなツールがあります。

基本的にPCで閲覧する文書を作るものという立場に立って、代表的なものと比較してみます。

メモ帳に代表されるテキストエディタ

軽い。しかし、表現力が弱い。

Microsoft Word

入力するときに書式が反映されるので、出力を予想しながら入力しやすく、わかりやすい。しかし、大きな文書では動作が遅くなり、希にファイルが壊れることもある。

Microsoft Excel

いわゆるExcel方眼紙で、帳票スタイルの文書を作りやすい。しかし、文書のレイアウトの変更をする際などに、文章の再利用に手間がかかる。帳票には向くが、文章には不向き。

TiddlyWiki5

操作がわかりやすい。簡単に始められる。ただし、ブラウザでの閲覧が前提。

Sphinx

Pythonからのインストールが必要。Windowsでは文字コードに気をつける必要があり、PCをあまり理解したくない人には不向き。出力のために変換作業が必要で、入力時に出力結果が想像しにくい。しかし、文書を構造的に作る際には作り易く、説明書や仕様書の作成に向く。