読者です 読者をやめる 読者になる 読者になる

YAMAGUCHI::weblog

土足で窓から失礼いたします。今日からあなたの息子になります。 当年とって92歳、下町の発明王、エジソンです。

Sphinx

sphinxcontrib-golangdomainをリリースしました

はじめに こんにちは、Python界の情弱です。Goのコードリーディングをするにあたって、メモをSphinxで書こうと思ったんですが、Go用のドメインが見つからなかったので、標準で入っているCドメインとPythonドメイン、あと@shibukawa作のErlangドメインを参考…

Sphinxで文章を書く際のEmacs環境設定 2012.12版

はじめに こんにちは、Python界の情弱です。このエントリはSphinx Advent Calendar 2012の2日目のエントリです。1日目の@r_rudiより受け取りました。完全に使い回しのネタ+αとなってますがご容赦下さい。 Sphinx Advent Calendar 2012 - connpass 最近はVim…

ReadTheDocsでSphinxホスティングは磐石(になる予定)

はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思…

設定ファイルなどをまるごと表示する

はじめに マガンダンハポン(こんにちは)、Python界のガイガーカウンターです。さてSphinxでドキュメントを書いているときに設定ファイルなどをまるっと読み込んで載せたいときがあります。そういうときにはliteralincludeディレクティブが便利ですよ、とい…

PyCon mini JPに参加した&LTした

当日のプログラムはこちら 関連リンク PyCon mini JP リンク集 #pyconjp - aodag's posterous PyCon mini JP ☆20110129 - Togetter 初LTしました 大勢の前でLTするのは何気にはじめてで、緊張してめちゃくちゃ早口になってしまったのでかなりあっという間に…

サイドバーでtoctreeの深さを変更する

はじめに こんにちは、Sphinx-Users.jpの大声担当です。今日はSphinx三昧ですが、ちょっとはまったのでメモ。 toctreeの深さを変更する Sphinxで大事なのはtoctreeの存在ですね。index.rstにはtoctreeディレクティブがあってmaxdepthオプションをつければ深…

多数のURLがパラグラフ中に出てきた時の対処

はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。さて、翻訳などをしていて文章中に引用などでURLが1パラグラフ中に多発することがあります。reSTでそれをどう書くかちょっと考えました。 元のHTML ここで黄緑になっているところがハイパーリンク…

文章の途中に画像を埋め込む

本当にちょっとしたTipsなのでメモがわりに。 reSTで文章を書いていて、ふと文章中に数式とかを入れたい時があります。その時にpngmathなどで生成した画像をはめこんだりしますがSphinxでは置換で対応できます。 An example of set notation would be |compr…

pydoc内のドキュメントを翻訳していてはまったこと

はじめに こんにちは、Python界のセカンドバージンです。さて、一昨日のエントリで書いたとおりJInja2ドキュメント日本語訳を公開しました。きっかけは最近Sphinxでテンプレートをつくろうと思ってたり、Flaskでアプリケーションつくろうと思っていたので、…

JUS勉強会でSphinxの紹介をしました

はじめに こんにちは、Python界の海老蔵です。去る2010年12月3日にJUS勉強会にてSphinxの紹介をさせていただきました。その時に少々トラブルがあり、ご紹介したかったリンクなどが残念ながら紹介できなかったのでここにリンクや当日のスライドを貼っておきま…

reStructuredText(reST)をEmacsで書く際のまとめ

はじめに こんにちは、非モテエンジニアです。長らくExcelで仕様書を書くのがブームらしいですが、Sphinxでドキュメントを書くと耳から脳漿垂れ流しになってしまうほど楽しくなってしまうというもっぱらの噂(俺の中で)なので、EmacsでreSTを書く際の便利機…

bitbucketを使ってSphinxのソースを管理

動機 この間翻訳で使ってみたらかなり使いやすかったんで始めてみた。これからドキュメント書きに使いそうなのでメモ。 手順 レポジトリの準備 Free source code hosting — Bitbucket bitbucketでMercurialのプロジェクトを作成する。 これでプロジェクトが…