タグ

Sphinxとfrom_greaderに関するkshimo69のブックマーク (8)

  • Sphinxでmscgen / graphviz | Go for it!

    Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する(dot形式というらしい)と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、題。 Sphinxにはこれらの拡張が用意されています(標準ではないです)。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package

  • Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発/教育ソリューションのタイムインターメディア

    システムインテグレーション、教育機関向けICTソリューションならタイムインターメディアにおまかせください。 あらゆるITニーズに対して豊富な業務知識と卓越した技術力でお答えします。 株式会社タイムインターメディア 〒160-0002 東京都新宿区四谷坂町12-22 TEL:03-5362-9009 / FAX:03-5362-9008

    Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発/教育ソリューションのタイムインターメディア
  • 設定ファイルなどをまるごと表示する - YAMAGUCHI::weblog

    はじめに マガンダンハポン(こんにちは)、Python界のガイガーカウンターです。さてSphinxでドキュメントを書いているときに設定ファイルなどをまるっと読み込んで載せたいときがあります。そういうときにはliteralincludeディレクティブが便利ですよ、という話。 こんな感じ コードサンプルの表示 — Sphinx v1.0.6 documentation また使用するポートを固定するためにあらかじめ :file:`staticports.ini` ファイルを作成する。 .. literalinclude:: ./files/staticports.ini :language: iniこれでsetting.iniというファイルをiniファイル形式のハイライトを使って囲み表示出来ます。

    設定ファイルなどをまるごと表示する - YAMAGUCHI::weblog
  • PyCon mini JPに参加した&LTした - YAMAGUCHI::weblog

    当日のプログラムはこちら 関連リンク PyCon mini JP リンク集 #pyconjp - aodag's posterous PyCon mini JP ☆20110129 - Togetter 初LTしました 大勢の前でLTするのは何気にはじめてで、緊張してめちゃくちゃ早口になってしまったのでかなりあっという間に終わってしまいましたが、とても楽しかったです!またLTしたい! [20110129] sphinx theme collection 2011春View more presentations from Yoshifumi YAMAGUCHI. 感想など 各発表者の方々が各自のサイトでスライドの掲載および、解説をしてくださっているので、自分は感想等を簡単に載せておきます。 開会宣言 増田さん(@whosaysni)による開会の挨拶。日Pythonコミュニティの現状と、世

    PyCon mini JPに参加した&LTした - YAMAGUCHI::weblog
  • PyCon Mini JP 「お前、誰よ」まとめ

    昨日、 PyCon Mini JP にSphinx 1.1 の i18n 機能について発表しました。 Python コミュニティの偉い石さんが 日Pythonコミュニティの歴史について、いいキーノートを発表してくれたけれども、いろなPython 開発者がみんな集まる PyCon みたいなイベントが珍しいので、最初は固くて、重たい気持ちを感じました。 清水川さんや、鈴木さんがアイスブレークしようとしましたが、固い雰囲気が続いてしまった。 私はスタッフさんから無理やりアイスブレークをするのが非常に難しいと認識した。もし、スタッフさんがよく頑張ってくれたのに、みんなさんがあまり楽しめずに終わってしまったら、非常に残念なことになるなと思った。発表が受けられるために、以前にいろいろ考えて資料を作ったが、もうちょっと軽い気持ちをさせるため、発表する前に、ギリギリな時間に #bucho の写真の

  • reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。

    Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない

    reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
  • SphinxでかんたんePubファイル作成

    警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 日時: 2010/05/21 作者: 渋川よしき 最終更新: 2021/02/12 Sphinxの1.0からは、ePubファイルのビルドができるようになります。ePubファイルというのは、iPadやソニーの電子ブックリーダーなどで利用できる、電子ブックのフォーマットです。原理的にはHTMLに、決まった形式のメタデータを含むファイルを追加して、zipで固めて拡張しをepubにしたものですが、Sphinxを使えば簡単に出力することができます。

    SphinxでかんたんePubファイル作成
  • Sphinx の Blogger 原稿用拡張を作ってみました

    Bloggerの原稿をいちいち手で書くのが面倒だったので(特にリストとかpreとか)、Sphinxを使ってBloggerの原稿を書く拡張を作ってみることにしました。 参考にしたページはこちら。 http://sphinx.shibu.jp/ ■サンプルとダウンロード githubにアップしてみましたので、こちらからご利用いただけます。 http://github.com/akisute/sphinx_rst2blogger 実際に変換させてみたサンプルをこちらに用意してみました。 http://gist.github.com/317478 ■設定 完全に私の個人使用向けになっているので、そのままではたぶん使いにくいと思います。まずはMakefileの以下の部分をご自身の環境に合わせて書き換えてください。blogger: $(SPHINXBUILD) -b blogger $(ALLSPHI

    Sphinx の Blogger 原稿用拡張を作ってみました
  • 1