警告

この記事は古い為 sphinx-users.jp を参照してください。

第3日目 Sphinxドキュメントを書く道具

昨日はプロジェクトを作成した直後にhtmlを生成できる事を確認しました。 今日は、やっとSphinxドキュメントの作成に入ります・・・と思わせておいて、重要なテキストエディタについての説明をさせて下さい。

テキストエディタを使おう

ドキュメント作成を始める前に、ちょっと待って下さい!あなたは普段、どんなテキストエディタを使ってますか? もしもWindows標準の メモ帳 を使っているのなら、

文字コードをUTF-8に変更できるテキストエディタ

を探して来て下さい。もしもよくわからなければ、今日は サクラエディタ の使い方を覚えましょう。

  • 秀丸、Emacs、Vim、Eclipse等々、既にお気に入りのエディタやIDEがあるのなら、今日は読み飛ばして下さい。

サクラエディタについて

サクラエディタ はWindows用のフリーのテキストエディタとして長年親しまれ、今もなお開発が活発です。 標準で色々な機能が付いていますので、Windows標準の メモ帳 を使っているならば乗り換える事をお勧めします。

サクラエディタのインストール

文字コードの変更方法

  • Sphinxドキュメントを作成するには 文字コードUTF-8 に変更する必要があります。毎回、下記の作業を行う必要がありますので必ず覚えて下さい!

  1. サクラエディタで文字コードを変更したいテキストを開き、右下に表示されている文字コードを確認して下さい。 SJIS と表示されているはずです。

    ../../../_images/writing_tool01.png
  2. メニューの ファイル -> 名前を付けて保存 をクリックします。

    ../../../_images/writing_tool02.png
  3. 文字コードセットを UTF-8 に変更します。

    ../../../_images/writing_tool03.png
    • 改行コードの変更は不要です。UNIX/Linuxの LF でも Windowsの CRLF でも問題ありません。

  4. 保存 をクリックします。

    ../../../_images/writing_tool04.png
  5. 上書きしますか?と聞かれますので はい をクリックして下さい。

    ../../../_images/writing_tool05.png
  6. 右下に表示される文字コードが UTF-8 に変わった事を確認して下さい。

    ../../../_images/writing_tool06.png

シンタックスハイライト

  • シンタックスハイライトとは特定の単語や構造に色を付けて分かり易くする機能です。 Sphinxで使用する reStructuredText という記法をサクラエディタでシンタックスハイライトする為の設定を公開されている方がいらっしゃいます。

    SakuraEditorTypeRest

    ここで有り難く使わせて頂きましょう。

  1. 下記リンク先のZIPファイルをダウンロードします。

    https://github.com/tohosaku/SakuraEditorTypeRest/archive/master.zip

  2. 任意の場所にZIPファイルの中身を展開し reST.ini が存在する事を確認して下さい。

  3. サクラエディタを起動し、メニューの タイプ別設定一覧 をクリックして下さい。

    ../../../_images/writing_tool07.png
  4. 設定(数字) をクリックしてから ** をクリックして下さい。

    ../../../_images/writing_tool08.png
    • 今回は 設定18 で進めます。

  5. 2で展開した reST.ini をクリックし 開く をクリックして下さい。

    ../../../_images/writing_tool09.png
  6. バージョンが異なります と出ますが無視して はい をクリックして下さい。

    ../../../_images/writing_tool10.png
  7. インポート条件を聞かれますので OK をクリックして下さい。

    ../../../_images/writing_tool11.png
  8. OK をクリックして下さい。

    ../../../_images/writing_tool12.png
  9. Sphinxドキュメントを開くと、色が付くようになります。

    ../../../_images/writing_tool13.png

便利なショートカット

サクラエディタのキーバインド

効果

キー

もとに戻す

Ctrl + z

やり直し

Ctrl + y

一行切り取り

Shift + Delete

一行コピー

Ctrl + c

現在行を複製

F10

先頭(左側)の空白を削除

Alt + l

末尾(右側)の空白を削除

Alt + r

矩形選択開始

Shift + F6

矩形貼り付け

Shift + F9

  • 便利なショートカットや機能はまだまだ沢山ありますので、時間のある時にメニューバーを1つずつ開いてじっくり調べてみて下さい。

さあ、明日はSphinxドキュメントを書く為に必要な reStructuredText の説明です。

※ このアドベントカレンダーについては このアドベントカレンダーについて を参照して下さい。

Comments

comments powered by Disqus