• Showing Page History #74301

Sphinx-docxbuilder について

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

  • セクションのヘッダ
  • インラインマークアップ(テキストのスタイルを変更するもののみ)
  • リストと引用のようなブロック
  • リテラルコードブロック(ソースコード等の記述用)
  • シンプルテーブル
  • 一部のAdmonition
  • イメージの挿入
  • 独自のスタイルの変更(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']
次に、書きのコマンドを入力するとdocx形式の文書が生成されます。
  $ 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

スタイルファイル

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

  • docx_style

Latest File Release

This Project Has Not Released Any Files

Recent Tickets

(empty)