Sphinx+翻訳 Hack-a-thon 2015.01 - connpass 参加時に書いたエントリーです。

参加のきっかけ

Sphinxは1年前くらいに触ってみたものの、その後、利用機会がなく使い方を忘れてしまう...
今回再チャレンジを検討してみるも、再度挫折しそうな気もするので、本イベントを利用させてもらって集中的に取り組もうと考えた。
※ イベント名にはハッカソンってなっているけど、参加対象／趣旨は下記の通りで参加しても問題なさそう（問題なかった）

主に以下の方を対象にしています。
  Sphinx で文章を書きたい/書いている人
  ドキュメントの執筆/翻訳をしている人 ( Sphinx を使ってなくても ok )
  Sphinx のハック(改良、拡張づくり、テーマづくりなど)をしている人
  Sphinx に興味がある/使ってみたい人
  その他ドキュメントに関する素敵ななにか (all that's nice :-)

一人では辛くてすぐ飽きちゃう活動も、みんなと一緒ならがんばれる！というのが目的です。

なお、タイムテーブルにある通り、自己紹介と本日のゴール設定〜黙々〜成果発表する流れ。
自分は、Sphinx再チャレンジというボンヤリした目標なので、Blogにアップする事をゴール設定とした。

使用環境

• Mac Yosemite

  $ uname -a Darwin mac-3.local 14.0.0 Darwin Kernel Version 14.0.0: Fri Sep 19 00:26:44 PDT 2014; root:xnu-2782.1.97~2/RELEASE_X86_64 x86_64

• Eclipse

  最近Eclipseを利用し始めたので、Eclipse前提で環境をセットアップした。
  インストールしたEclipseは 4.4 Luna 。

環境設定

Sphinx Install

• Pythonインストール

  Pyenvにて2.7.8 をインストール

  MacにPythonインストール - Edo::Blog

• Sphinxをインストール

  pipからインストール

  $ pip install sphinx

Eclipse Setup

• 参考URL

  eclipseでサクサクsphinx | 247jp -斜め上の未来へ-

  Python環境とSphinxエディタとしてのEclipse | MemeTodo

• Eclipse Marcketplaceから"ReST Editor"を入力

  

• Menu画面から[Run] - [Run Configuration]

  

• 左メニューから[Sphinx (via make file)] - [new configuration]を選択

  

  

• Mainタブのプロパティ修正

  • Name
    • 任意の値に変更
  • Working directory
    • ${workspace_loc:/sample} ※Eclipseのワークスペース:<プロジェクト>を指定
  • Sphinx output
    • "html"にチェック ※html以外を生成する場合は別途変更

  

• Environmentタブのプロパティ修正

  Newをクリック

  

  PATH変数を追加

  

Eclipseプロジェクト作成

• [File] - [Other] を選択

  

• [ReST Editor] - [Sphinx project] を選択

  

• ウィザードに従いインストール

  適当に次へでウィーザードを進める。AuthorsやVersion、Language等は環境に合わせて。なお、HTMLテーマは標準インストールのものしかウィーザードでの選択はできない。

  

• プロクジェクト完成

  

Python設定

• EclipseへのPython設定

  Runすると下記エラーが発生した。

  

  どうやらPythonファイルアイコンをみるとXcodeに紐付いるので、EclipseからPythonとして認識させる必要がありそう。

  

以下追加設定。

• プラグイン（Pydev）をインストール

  eclipse marketplaceからPyDevをインストール

  

• Pythonインタプリタ設定

  メニューバーから[Eclipse] -[環境設定]を選択

  

  左メニューから[PyDev] - [Interpreters] - [Python Interpreter]を選択

Pythonのパスを選択

ライブラリがロードされていることを確認

ドキュメント作成（make html）

ようやく本題

• Run

  EclipseからRun実行すると下記コマンドが実行される。

   sphinx-build -b html -d build/doctrees   source build/html
   Making output directory...
   Running Sphinx v1.2.3
   〜中略〜
   build succeeded.
   
   Build finished. The HTML pages are in _build/html.

• プレビュー確認

  Index.htmlをEclipseから参照可能....（何故かサイドバーが表示されてない。Webブラウザからのプレビューでは表示される。）

  

  conf.pyのthemeを"bizstyle"から"default"に戻したらサイドバーも表示できた...

  

最後に

再入門という記事タイトルにしたが、環境周りのセットアップ記事で終わってしまった。
引き続きSphinxを触ってドキュメント生活を軌道にのせたい。