2012/11/21

Sublime text 2でSphinxを使う

最近、評判のSublime Text 2とSphinxを使ってドキュメントを書いて見たのでおぼえがきの意味も含めメモ

事前準備



Sublime text 2のインストール


公式サイト(http://www.sublimetext.com/)から該当のOSのパッケージをダウンロードし、インストールを行う。

インストールが完了後、定番のPackage Contorolを入れる。

インストールからPackage Contorolを入れるまでの手順は以下のサイトを参考に行なった。

Sublime Text 2がプログラミング人生を変えるかも知れない
 http://tak0303.github.com/2012/09/25/how-to-use-sublime.html


Sphinxのインストール



公式サイト(http://sphinx-users.jp/)のチュートリアルを元に

 ・Python3.2のインストール(お好みのバージョンでOK)
 ・Setuptool(Easy_Install)をインストール
 ・Easy_InstallからSphinxをインストール

一応、動作確認の為、コマンドプロンプトからsphinx-quickstartを実行



正常に動作すれば準備完了。

Sublime text 2のパッケージインストール


sphinxをSublime text 2で動かす為にパッケージのインストール入れたパッケージが

 ・Restructured Text (RST) Snippets
 ・Markdown Preview

最低限必要なパッケージは、これぐらい。ぶっちゃけ、なくても問題はない。

build環境の構築


さて、ここからが本題。
build環境の為,メニューの中にある

[Tools] - [Build System] - [New Build System...]



を選択し、開いたファイルに以下のコードを入れてファイルを保存する。(ファイル名は、sphinx.sublime-buildとかにする。)




これで準備完了なのでドキュメントを書いたら、さきほどのメニュー内に新たにsphinxの項目が追加されているので

[Tools] - [Build System] - [sphinx]

を選んだ後に、ctrl + b でbuildが開始される。

ビルド前に確認したい時は、Markdown Previewを使い確認をする。
(PreferrencesのKey Bindings-userに起動用のショートカットコマンドを登録しておくと便利)

あとはお好みでGitで管理をするなりすればOK!

2012/09/18

デブサミ関西に行ってきた。

2012/09/14に行われたデブサミ関西ことDevelopers Summit 2012 Kansaiに参加してきた。

今回は、多少のMPができたこともあり、参加に至った次第である。

今回参加して思ったこと

今回、特に気になったな部分は以下の2点

「開発方針(テーマ)の共有が重要であること」

  • 何を目的に行うのかがいかにブレずに行うか。また、その為になるべく自動化できることは機械にやらせる事により本来、注力すべきところに力を注ぐ。
  • 重要だがこれが外乱によりなかなかできない。そのためにも定期的なふりかえりを行い、ブレた部分を補正して行けばいいといったことが理解できた。


「やっていることを習慣化するするためには1年かかる。これをツールや仕組みを使い上手く習慣化に持っていく」

  • 前者とも共通する部分だが習慣化するためにも定期的なふりかえりを行いつつ自分の物にしていくことが重要であり、そのいい部分を水平展開していけるようになりたいとも思った。

毎回、こういったイベントに参加して多くの気づきができることが嬉しく思う。
これを継続するためにも、自分から発信できるよう、努力をしていきたいと思う。

あっ、そーいえば、会場の様子撮影するの忘れてた。

p.s.LT大会は、TDDBC岡山でお世話になったTAのみなさんの一部が若干、大都会に侵されていたような...
  (通常のLT大会が普通で大都会のLT大会が異常なだけだったりして...)

2012/08/27

TDDBC 岡山に行ってきた

2012/08/25に開催されたTDDBC岡山1.0に参加してきました。

今回は、スタッフとして参加しました。(実はTAは初めてだったりした。)


セッション内容

和田さん(@t-wada)のセッションでは、TDDの目的等をわかりやすく説明していただき。
色々な気づきにめぐり会えたと思いました。

ワークショップ

TDDBC大阪で使った課題を基に言語ごとにわかれてペアプログラミングを実践しました。
C#で初めてTAをやりましたが今まで知らないIDEの使い方などを教えてもらい、
すごく勉強になりました。(京アジャの前川さん(@Posaune)技術的フォローありがとうございました。)

今回の勉強会を振り返り

privateのテストの見解について

  • 今まではカバレッジを意識してprivateについてもどうやってテストを通すかを考えすぎていた。
    (リファクタリングを意識するとprivateが邪魔になってくる場合がある。)

  • privateはpublicを作っていく過程で生まれていくものなのですでにテストに内包されている。

    和田さんが言われていた「正面玄関からテストしよう」との言葉がこのあたりのことをすべて集約しているように思えた。(このあたりの話はきよくらさん(@kiyokura)も書かれているので…)

    感謝
    今回は遠方から参加頂いた方々ならびにご協力いただきました皆様、本当にありがとうございました。
    また、主催のあべさん(@mao_instantlife)お疲れ様でした。今後もこのような機会を増やしていければ
    いいなと思いつつ、自分ももっと勉強しないといけないなと思ったイベントでした。

    P.S.懇親会は、今までに無いぐらい盛り上がりました。(他の地域はどうなんだろう?)