つい先日、SphinxCon JP 2014 が開催されました。 僕は所用があったため、午後の発表と懇親会だけ参加しました。 「Sphinx をはじめよう」というテーマの通り Sphinx 初心者/中級者に向けた発表がメインでしたが、 本家のアップデート報告、事例紹介、拡張、…

このブログでは numfig の闇と向き合う の記事から numfig との取っ組み合いをしていましたが、 ひょんなことから Sphinx 本体の改修を手伝うことになり、 つい先日 Assign numbers to figures, tables and code-blocks というプルリクが本体に取り込まれま…

少し前、インターン生として @yassu がうちの会社に来ていたので、 その際にドキュメント作成に使うツールを作ってもらいました。visio2img と sphinxcontrib-visio の 2パッケージです。 それぞれ、visio2img は Visio ファイルから画像ファイルを抽出する…

すでに渋谷では SphinxCon 開催の話題でもちきり状態で、 ご存じない方はもういらっしゃらないとは思いますが、今年も SphinxCon JP 2014 を開催します。今年も SphinxCon JP を開催することになりました！10/26(日)です。発表者、参加者の募集を始めたので…

相変わらず perl を書いてはいないのだけど、あのお祭り感が大好きなので 今年も YAPC::Asia に行ってきました。帰り際に HUB で飲んでた時にスポンサーの人に煽られたのでなるはやで書いてます。@941 さんにまだブログ書いてない男の人とか…って言われたの…

only ディレクティブを組み合わせるとあれこれ微妙な挙動が発生するようです。最初は toctree と only ディレクティブの組み合わせについて悩んでいたのですが、 他にも only ディレクティブに関わる動きを @shimizukawa に教えてもらったので 合わせて紹介…

先々週に cacoo の拡張をつくってそのあとパッケージングもしたのですが、 それに味をしめて(?) UML 系のツールとして名高い astah 向けの拡張もつくってみました。 sphinxcontrib-astah です。やっていることは超シンプルで、内部で astah-command.sh を呼…

numfig を実装してやらぁ！と息巻いてコードを書き始めたところ、 シンプルだと思っていた toctree の裏に思わぬ魔境が広がっていて 思わず部屋の隅っこで震えてしまった @tk0miya です。Sphinx のリファレンスを舐めるように読み尽くした toctree マニアに…

今日、こんなツイートをみました。@wataradio blockdiagシリーズか、cacooで作った図をpngで利用ですかねー #sphinxjp— Takayuki Shimizukawa (@shimizukawa) 2014, 8月 12Cacoo で更新した図を Sphinx に貼り付けるにはローカルに保存する必要があります。 …

Sphinx ではラベル記法と :ref: 記法を使って、 ドキュメントの様々な位置にラベルを張り、それを参照することができます。 .. _target: section --------- セクションへの :ref:`参照 <target>` を作ります。 さて、このとき、ラベルを貼っているのがセクションタイ</target>…

numfig の闇を垣間見るのにも飽きてきたので、これまで見た numfig 系拡張の問題をカバーすべく 自分でも numfig 系拡張を書いてみた。 new_numfig.pyざっくり動かしたところ、うまく動いているようにみえる。既存の fignum 系拡張との違いはこんな感じ。 表…

昨日の記事で、どの拡張も HTML に変換した時に他のページにリンクできないという体たらくなので、 Sphinx においけるリンクの解決方法をまとめておく。 解決方法: domain#resolve_xref() を使う 以上。 見出しで言い切ったのでこれ以上ネタも無いのだが、コ…

前の記事で あとは numfig の応用で自動採番をすることもできるようになるでしょう。 なんてことを書いてみたのだけど、よく考えてみると一度も numfig を使ったことがなかったので これを機に挑戦してみんとてするなり。 numfig をインストールする numfig …

rstのファイルでリストに通し番号を入れる（久々にシェル芸） を見て、"code-block にキャプション付けられなかったっけ?" とおもって調べてみたところ、 Sphinx の code-block ディレクティブも docutils の code ディレクティブもどちらもキャプションをサ…

docutils はある形式の文書を別の形式に変換するフレームワークです。 このフレームワークを利用して rst2html や rst2latex などが提供されています。しかし、docutils が標準で対応している入力形式は reST 形式に限られているので、 実際には reST 変換用…

flake8 のドキュメントを読むと、 警告を抑止する NOQA コメントについて lines that contain a # noqa comment at the end will not issue warnings. (訳: 末尾に # noqa というコメントがある行は警告されません) と説明されています。しかし、実際にはす…

先日、Re: SphinxのLaTeXのフォーマットをいじる の記事を書いた直後に、 sphinx-users ML に独自のclsファイルを使用する方法がポストされました。前回の記事では conf.py でプリアンブル部にゴリゴリ定義を突っ込んでいましたが、 Python の文字列として記…

この間の Sphinx+翻訳 Hack-a-thon で話題に上がった件について調査してみた。お題は以下のとおり。 元の文書は markdown で記述されている Sphinx を使って翻訳してみようと思っている 元の文書が更新された時に差分管理できるとよい その場で出た案はタイ…

卒論とか修論は TeX で書いていた割には、TeX マクロが苦手な @tk0miya です。 先輩から秘伝のタレ的?なスタイルファイルを頂いたのでそれで済ませてました。Sphinx で PDF 出力するときは TeX を介して出力することが多いのですが、 未だに TeX マクロをち…

Pillow 2.2.0 以降には ImageDraw#textsize() にバグがあり、TrueType フォントを指定していると正しい高さが返りません。 どういう問題なのか テキストとそれを囲む四角を描画する次のコードを実行してみます。 from PIL import Image, ImageDraw, ImageFon…

最近、Sphinx や docutils の blockdiag ディレクティブのオプションを見なおし、 reST 標準の image/figure ディレクティブと同じオプションを受け取るようにしました。 :width: や :height:、:scale: などのオプションが使えるようになっています。その際…

Sphinx 拡張ではエラーを表示したくなる場面はいくつかある。 設定値が誤っている場合や、環境の設定不足、記述の誤りや通信エラーなど。そんなときに Sphinx/docutils フレームワークを使ってエラーを出力していくのだが、 場面や用途によってエラーの出力…

パーフェクト Ruby の初版、p.486 にバグを見っけた。 公式の正誤表は見当たらなかったので記事にしておく。capistrano の capture 関数のサンプルとしてリスト 14.14 にこんな記述がある。 task :log_size_watcher do log_file = "#{deploy_to}/shared/log/…

書こう、書こうとおもってさぼってた話を書きます。複数の Python バージョンをサポートするライブラリを作っていると、tox があるとテストがとても楽になります。 ただし、Python のバージョンによって依存するライブラリが変化する場合は、 setup.py と to…

一度テスト環境を作ったまま、そのままテストを回し続けていた PHP プロジェクトがあるのですが、 composer が Warning: This development build of composer is over 30 days old. It is recommended to update it by running "composer.phar self-update" …

新年早々富士山見てきましたが、超寒かったです。でも、逆さ富士と赤(っぽい)富士を見ることができました :-) さて、2013年もようやく終わったのでちょっとだけ振り返りしてみることにしましょう。2013年の抱負 として挙げたのは ドキュメント系のツール/コ…