Lionet is a simple django application to publish Sphinx-generated documents.

Lionet は、Sphinx でビルドした pickle 形式のドキュメントリソースを公開するためのアプリケーションです。

主な機能

• ドキュメントのコンテンツや、索引・モジュール索引は、本文とメタデータ情報をもとにテンプレートエンジンで生成されます。したがって、ドキュメントのメタデータやビルド環境データをテンプレート上で加工して出力できます。
• 簡単な検索インタフェースがついていて、コンテンツを検索できます。
• 複数のドキュメントプロジェクトを管理でき、サイト全体のSphinxドキュメントコンテンツに対する総索引・総モジュール索引・検索を実行できます。

使い方

Sphinx を使って、好きなドキュメントを pickle ビルダでビルドします。

$ cd your/sphinx/docs/
$ make pickle

通常、この操作で、Sphinx は your/sphinx/docs/build/pickle に pickle ビルドを生成するはずです。

django のプロジェクトディレクトリの urls.py に lionet の urlconf を組み込みます。 単一のドキュメントしか扱わないのなら、 lionet.standalone_urls を組み込むだけ。 settings.py に手を加える必要はありません。

urlpatterns = ('',
   ...,
   (r'^lionet_standalone', include('lionet.standalone_urls'), 
    {'document_root': '..,your/sphinx/doc/_build/pickle'}),
   ...)

複数のドキュメントを扱いたいのなら、django のアプリケーションとしてインストールします。

settings.py
---
INSTALLED_APPS = (
  ...,
  'lionet',
)

urls.py
---
urlpatterns = ('',
   ...,
   (r'^lionet_multiple', include('lionet.multiple_urls'), 
    {'document_root': '..,your/sphinx/doc/_build/pickle'}),
   ...)

syncdb を忘れずに！ admin で、 ドキュメントディレクトリを登録しましょう。 name にはドキュメントディレクトリを区別するパス (例: lionet_multiple/userguide/... の userguide)、 label にはドキュメントディレクトリを説明する短い言葉 (例: ユーザーズガイド)、 document_root には pickle ディレクトリを指定します。

/lionet_standalone/ または /lionet_multiple/(project_name)/ にアクセスしてみてください。 enjoy!