ドキュメント作成システムSphinxが便利

WWDC直前ですが,ドキュメント作成のお話を。

最近知ったのですが,1つのプレーンテキスト(reST)からPDF, html, ePub, Wordのドキュメントを生成するシステムSphinxが便利そうで,試行錯誤しています。

SphinxはPythonのドキュメント作成のための作られたシステムです。以下のリンクでSphinxのことがよく分かります。

Sphinxユーザー会

ドキュメントを作りたくなってしまう魔法のツールSphinx

Pythonのドキュメントを作れるシステムなので,

  • コードハイライトがきれい。対応する言語も多い。
  • 数式はTeXで処理するのできれい。
  • プレーンテキストで書くので,Gitなどでバージョン管理可能。
  • Python環境があれば,すぐにインストールできる。
  • 関連するドキュメントが日本語化されている。

などいろいろいいところがあります。

reSTはreStructuredTextで,マークアップ言語の1種です。世間ではMarkdownのほうが知られていますが,似たような記法です。=, -, ^などで囲めばタイトルになり,+を頭につけるだけで箇条書きになるので,読みやすい文章がかけます。GithubやQiitaの原稿がMarkdownなので,Markdownを使うことが多いかと思います。その場合はPandocで変換できるので,reSTに変換することができるので,特に問題ないです。

htmlでざっくりかいて,確認して,完成版をPDFに変換するということができます。Wordで作文するのに飽きている人にはぜひおすすめします。

こちらもどうぞ

コメントを残す

メールアドレスが公開されることはありません。