しおしお

IntelliJのあれやこれや

IntelliJでSphinxドキュメントを書いてみよう

IntelliJSphinxを使う手順のまとめ。

前提

IntelliJSphinxを使うための必要な下記のモジュールのインストールができていること。

IntelliJPythonプロジェクトの作成

Sphinxを利用するためには、Pythonプロジェクト(PythonモジュールでもOK)が必要なので、Pythonプロジェクトをつくります。

作り方は、Javaプロジェクトを作る時と同じようにCreate New Projectから行います。
New Projectの画面で下の画像のように、Python Moduleを選択します。プロジェクトを作成するディレクトリや名前は好みで付けましょう。
f:id:sioiri:20121230120800p:plain

次の画面では、使用するPythonSDKを選択します。選択するものがない場合は、ConfigureからPythonSDKを登録してあげます。登録する際には、SphinxをインストールしたPythonの実行モジュールを選択してあげます。
f:id:sioiri:20121230120806p:plain

最後にFinishでプロジェクトの作成は終わりです。

sphinx-quickstartの実行

tool->Sphinx Quickstartから実行できます。色々聞かれるので答えていけばSphinxドキュメントルーツが作成されます。
Sphinx Quickstartが終わるとこんな感じに、conf.pyやテンプレートディレクトリが作成されます。
f:id:sioiri:20121230221730p:plain

ドキュメントのビルド

実行構成からSphinxドキュメントをビルドするためのビルド構成を作成します。

f:id:sioiri:20121230222417p:plain

実行構成では、まずSphinx taskを選択します。
f:id:sioiri:20121230223128p:plain

下の画像の枠内を必要に応じて設定します。(Command、input、outputは必須です。)
f:id:sioiri:20121230223357p:plain

作成した実行構成を実行します。Outputディレクトリにこんな感じに出力されてたら成功です。
f:id:sioiri:20121230223618p:plain

生成したhtmlはブラウザで確認しましょう。デフォルトのテーマだとこんな感じですね。
f:id:sioiri:20121230223726p:plain

カラー設定

Editor->Colors&Fonts->ReST fileで行います。
f:id:sioiri:20121231093038p:plain

補完など

キーワード補完はCtrl + Spaceで行うことができます。
f:id:sioiri:20121231093348p:plain

定義箇所へのジャンプも微妙ではありますが可能です。
例えば、以下の内容の場合リンクセクションの「大事なことは2回聞いておこう」部分で、Declaration(Navigate->Declaration)をすると大事なことは2回聞いておこうセクションに移動することができます。*1

大炎上プロジェクト
=====================================

大事なことは2回聞いておこう
----------------------------------
大事なことなので2回確認します。

.. code-block:: java

 if (hoge.equals("1")) {
   if (hoge.euqls("1")) {
     // 処理
   }
 }

リンク
----------
`大事なことは2回聞いておこう`_

この勢いで炎上案件のうんこーどまとめたら面白いかな?

おわり。

*1:複数rstにまたがるような移動はできなかったと記憶しています。