Sphinx-docxbuilder について

English Page

このソフトウェアは、SphinxドキュメントビルダでMS Word2007のファイルを出力するための機能拡張プログラムです。 現在は、次のような機能をサポートしています。

• セクションのヘッダ
• インラインマークアップ（テキストのスタイルを変更するもののみ）
• リストと引用のようなブロック
• リテラルコードブロック（htmlのpreタグに対応した機能、Pygmentsを使ったハイライトに対応）
• シンプルテーブル、CVSテーブル（複雑なテーブルには未対応）
• 一部のAdmonition（補足、警告、注意のみ）（スタイルを追加すれば他の形式も対応可能）
• イメージの挿入(px, %の表記をサポート、最大でも文書の幅に自動変換します)
• 目次ブロックを挿入（ただし、MS Wordで開いて更新する必要あり）

• 独自のスタイルに変更可能（docx形式のスタイルファイルを指定できます）

上記の機能でも、まだ使用できないものの一部あると思います。

使用方法

インストール

まず、Python2.6以上と下記のモジュールがインストールされていることを確認して下さい。

• sphinx 1.1.2
• lxml
• PIL (Python Imaging Libraray)

ソースコードをダウンロードして、Pythonのパス (sys.path)のディレクトリにコピーします。通常は、Sphinxが導入されているディレクトリに sphinx-docxbuilder をコピーするか、シンボリックリンクを作成して下さい。

Sphinx conf.pyの設定

sphinx-buildコマンドでdocx形式の出力をサポートするために、conf.pyの中の 'extensions'　に 'sphinx-docxbuilder'　を追加します。

  extensions = ['sphinx-docxbuilder']

  $ sphinx-build -b docx [input-dir] [output-dir]

conf.pyの設定(カスタマイズ編）

sphinx-docxbuilderでは、conf.pyに下記の設定をすることで出力されるdocxファイルをカスタマイズすることができます。

ドキュメントの情報

ドキュメントの作成者、タイトル、カテゴリ等のプロパティを変更するには、conf.pyに下記の設定をします。

• docx_title: タイトル
• docx_subject: サブタイトル
• docx_creator: 作成者
• docx_company: 会社名
• docx_category: 分類
• docx_descriptions:　コメント
• docx_keywords: キーワード

キーワードは、文字列のリスト、それ以外は文字列で指定します。 例えば、作成者を　'Isao HARA'とする場合には、

docx_creator = 'Isao HARA'

スタイルファイル

スタイルファイルを変更するには、conf.pyに下記の設定をします。

• docx_style

例えば、ドキュメントを作成するディレクトリにあるmyStyle.docxというファイルをスタイルファイルとして 使用する場合には、

docx_style = 'myStyle.docx'

もし、設定したスタイルファイルに必要なスタイルがない場合には、通常のテキストと同じ内容のスタイルが生成されます。 ただし、文字列の修飾の場合には、未定義だった文字スタイルは、文字が赤く表示されます。