JVM(Jython)上でSphinxを動かしてみた

使い道がないかもしれないが... 以下を参照すると、Jython上でPygmentsは動かないがいけるっぽい。

• http://stackoverflow.com/questions/1085791/does-sphinx-run-on-jython
• http://bitbucket.org/birkenfeld/sphinx/issue/265/sphinx-doesnt-run-with-jython251

ただし、autodocは動かないという情報も。やはり完全互換は難しいか。拡張機能を使うと他にも動かない部分があるかも。

試しに作ったものをDropBoxにおいておきました。

• http://dl.dropbox.com/u/7023440/sphinx4j/sphinx4j-0.1.zip

ソースはこちら。

• https://github.com/wadahiro/sphinx4j

使い方

zipを解凍すると、binディレクトリ以下にsphinx4jコマンドがあるのでこれを実行する。使用コマンドは以下の通り。

Usage: sphinx4j commands
Commands:
    install            -- install sphinx into your home directory
    sphinx-quickstart  -- run sphinx-quickstart
    sphinx-build       -- run sphinx-build

• installとすると、Sphinxと依存ライブラリをpypiからダウンロードしつつ$HOME/.sphinx4j以下に解凍します。これで準備完了。
• sphinx-quickstart とすると、sphinx-quickstartを実行してプロジェクトを作成することができる。ただし、生成されるMakefileではビルドできないので注意(python版のスクリプトを呼び出すため)。
• 代わりに、sphinx-buildでビルドする。以下のように、引数でソースディレクトリ ビルドディレクトリを指定する。詳細はsphinx-buildのドキュメントを参照のこと。

sphinx4j sphinx-build -b html source build

2012/05/05追記

• sphinx-buildのコマンド例が間違っていたので修正。