To sidebar

Saturday, January 23 2016

ドキュメンテーションツール 2016 (3)

ひとまず昨年のテキストを再現するところまでは完了できたつもり。

ソースコードのエリアに日本語入れても問題無い。

wmf の画像を eps に変換したときに日本語フォントがいまいちだったのは、一緒に出力していた emf から変換することで解決。

ソースコードは別ファイルに分離して、単体で動かせるようにもした。

表も csv インラインに直書きで対応。

これで singlehtml でも latexpdfja でも出力を確認。

ついでに git サーバーたてて、そちらに履歴を入れるようにした。日本語コメントはまだ対応していないけれど。

残りの作業は、

  • ソースコードがところどころ syntax highlighting が働かない理由を探る
  • ソースコード全てエラーがないことを確認
  • 昨年の反省点を反映
  • シミュレーターのも組み込む
  • 高位合成についても書く
  • git のコメントを日本語で入力できるようにする

といったところか

Sunday, January 17 2016

ドキュメンテーションツール 2016 (2)

引き続き Sphinx を試しているところ。

見出しというか、章や節の深さについては、reStructuredText入門 の「セクション」を見て解決。今回の対象のテキストはこのくらいの深さでカバーできた。

ソースコードや脚注、欄外の注釈なども順調に対処。

画像については Sphinxで出力フォーマットごとに記述を変更する でまずは latex とそれ以外を分離。LaTeX 以外には png を指定。

画像は元々 Visio で書いていたので、画像は png と wmf を出力していた。wmf を LaTeX 向けの EPS に変換するのは、WMF2EPS の開発が終了してしまったので、去年つかった LyX と一緒に配布されている MetafileToEPSConverter を使用。

ただ、最初は dvipdfmx が、EPS ファイルが見つからないとエラーになっていた。epspdf で問題の EPS ファイルを変換させようとしてみたら GhostScript が無い、というエラーだったので GhostScript (9-base) をインストールすることで解決。

ただこの Metafile To EPS Converter の結果が、フォントが違ってしまうので、TeX Live の日本語フォントも含めてチェックが必要そう。

でもとりあえず、おそらくこれで材料はそろったので、あとは PDF にしたときのスタイルや、HTML のスタイルや、EPUB のスタイルを考えるくらいか。

Monday, January 11 2016

ドキュメンテーションツール 2016 (1)

今年はまずは、Sphinx + LaTeX に挑戦。

Sphinx で sphinx-quickstart で作った Makefile がいきなりエラーで焦ったけれど、if うんぬんから endif までの3行をコメントアウトすることで回避。
(もともとコマンドがインストールされているかのチェックだけみたいだから)

ただ make で PDF を出力させようとしているのに tex 出力だけで何も言わずに終わってしまう。
日本語周りの例外の処理でエラーになってる模様。

どう対応していいかよくわからないので、Python 3 最新版をパッケージでインストールした後 Sphinx を pip でインストール。
TeX Live もオリジナルのサイトからインストーラーをダウンロードしてインストール。

パッケージ管理としては面倒になるけれど、これで Makefile の内容も少し変わったし、PDF 出力もされた。

内容に関しては、章や節の深さが、Sphinx のマークダウンだけだと浅いけれど、toc 周りを活用してファイル分割すればいけるらしい。
画像に関してのみ、EPS なりなんなり、ベクター形式でいければ、あとはスタイルをどういじるか……で済むと期待。

© pseudomoon.jp, after the WP Dusk To Dawn theme Powered by Dotclear