ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog
はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思うんですが、そのホスティングはみなさんどうされていますか？ Sphinx-Users.jpにいくつかホスティングの方法を紹介してありますが、今日は割と新しいホスティング方法のReadTheDocsをご紹介します。 ReadTheDocsってなに？ Home | Read the Docs rtfd/readthedocs.org · GitHub ReadTheDocsは2010年のDjango Dashで作成されたコードを元に公開されているサービス/ライブラリです。外部に公開されているSphinxのレポジトリ（G
Sphinxでmscgen / graphviz | Go for it!
Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する（dot形式というらしい）と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、本題。 Sphinxにはこれらの拡張が用意されています（標準ではないです）。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package
Sphinxのrstファイルの見出し一覧/絞り込み/移動をanythingで行なう - わからん
▼ 左が編集中のファイル、右が一覧 個人的に Sphinx を使い始めました。emacs23 に同梱されている rst.el の C-c C-t (rst-toc) が残念な仕上りだったので、anything で見出し一覧/絞り込み/移動できるようにしておきました。動作には migemo, anything, anything-migemo.el が必要です。 https://github.com/wakaran/rst-goodies/raw/master/rst-goodies.el 今後も Sphinx を使っていこうと思っているので、上記のファイルにまとめました。その他の機能としては、プロジェクトディレクトリ配下のファイルの編集画面で、M-x sphinx-compile すれば、make html します。今できるのはそんなところです。設定と使い方は以下のコメントを参照して下さい
設定ファイルなどをまるごと表示する - YAMAGUCHI::weblog
はじめに マガンダンハポン（こんにちは）、Python界のガイガーカウンターです。さてSphinxでドキュメントを書いているときに設定ファイルなどをまるっと読み込んで載せたいときがあります。そういうときにはliteralincludeディレクティブが便利ですよ、という話。 こんな感じ コードサンプルの表示 — Sphinx v1.0.6 documentation また使用するポートを固定するためにあらかじめ :file:`staticports.ini` ファイルを作成する。 .. literalinclude:: ./files/staticports.ini :language: iniこれでsetting.iniというファイルをiniファイル形式のハイライトを使って囲み表示出来ます。
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 「お前、誰よ」まとめ
昨日、 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など他の拡張子のファイルに書いていることに注意してください。そうしない
文章の途中に画像を埋め込む - YAMAGUCHI::weblog
本当にちょっとしたTipsなのでメモがわりに。 reSTで文章を書いていて、ふと文章中に数式とかを入れたい時があります。その時にpngmathなどで生成した画像をはめこんだりしますがSphinxでは置換で対応できます。 An example of set notation would be |comprehension|.That set notation tells you the results you want will be all real numbers who are equal to their own square. ... .. |comprehension| image:: img/comprehension.png こうしておけば、Sphinxでビルドしたときに画像がこんな具合にはめこまれます。
Macでrst2pdfを使ってヒラギノなPDFを作成する。 - そこはかとなく書くよ。
http://sphinx-users.jp/cookbook/pdf/rst2pdf.html を参考にさせて頂きました。 準備 macportsでsphinxとrst2pdfを入れます。 % sudo port install sphinx % sudo port install rst2pdf今回使用したバージョンは sphinx v1.0.4 rst2pdf 0.16 です。 なお、参考にさせていただいたページではIPAフォントなどを使っていますが、Macなのでヒラギノフォントを使います。なので、フォントを別途インストールする必要はありません。 プロジェクトの作成 いつも通りに sphinx-quickstart コマンドを利用してドキュメントを作ります。 conf.pyの編集 前述のrst2pdfのページを参考にしてください。 extentionに追加するほかは、 pdf_doc
Sphinx WebSupportを使ってみる - そこはかとなく書くよ。
Python Web フレームワーク アドベントカレンダー2010のバトンが回ってきましたので、書いてみます。 Sphinx version 1.1から、WebSupportというものが入りました。これは、sphinxのドキュメントをWebサーバにつなぎ、コメントや変更の提案、投票といった機能を追加してくれます。 これ単体だとWebフレームワークとは言い切れませんが、まあ誤差の範囲ということで許してください。 概要把握: 動作している様子 WebSupport開発者のJacob Masonさんが提供しているデモサイトです。これを見て雰囲気を掴んでください。 http://www.jacobmason.com/demo/contents ちなみにこのソースはbitbucketで公開されています。 必要なライブラリ WebSupportはコメントなどをsqliteのDBに保存しますので、それを
JUS勉強会でSphinxの紹介をしました - YAMAGUCHI::weblog
はじめに こんにちは、Python界の海老蔵です。去る2010年12月3日にJUS勉強会にてSphinxの紹介をさせていただきました。その時に少々トラブルがあり、ご紹介したかったリンクなどが残念ながら紹介できなかったのでここにリンクや当日のスライドを貼っておきます。 2010年12月勉強会「ドキュメントを作りたくなってしまう魔法のツール Sphinx」 参考 Overview — Sphinx 1.1.3 documentation 本家です。ドキュメントがあります。 Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp Sphinx-Users.jpのサイトです。Sphinx入門からTips、さらに応用まで多くのSphinx情報を提供しています。 Sphinxをはじめよう :: ドキュメンテーションツール スフィンクス Sphin
reStructuredText(reST)をEmacsで書く際のまとめ - YAMAGUCHI::weblog
はじめに こんにちは、非モテエンジニアです。長らくExcelで仕様書を書くのがブームらしいですが、Sphinxでドキュメントを書くと耳から脳漿垂れ流しになってしまうほど楽しくなってしまうというもっぱらの噂（俺の中で）なので、EmacsでreSTを書く際の便利機能をまとめてみました。 参照 404 Not Found 手前味噌ですが自分が関わっているSphinxの日本ユーザ会のサイトです。そもそもSphinxってなによ？Sphinx自体をどうやって導入したらいいのよ？って方はご参照ください。もちろん既にご存知の方にも最新情報含め有益な情報が満載です。 Emacs Support for reStructuredText rst.elの本家。英語ですがrst-modeについて一番詳しい説明がある場所だと思います。 rst.elの色設定 - DiaryException 色設定について詳しく説明
bitbucket + Sphinx + Google App Engineで自動更新サイトを作成する - YAMAGUCHI::weblog
動機 Sphinxを使って翻訳作業をしたりしているんですが、いちいち自分でビルドして、サイトに公開するのが面倒。そこで WebSocketのRFCの日本語訳を公開した時と同様にGoogle App Engineへ定期的にSphinxでビルどしたhtmlディレクトリをupするという方法を試してみた。 出来たもの とりあえずいまはこんな感じで動いています。 404 Not Found プロジェクト作成 まずはGoogle App Engine（以下GAE）のプロジェクト作成をする準備。今回はUbuntu 9.04上で環境を作ってみる。自分は一回作ったアプリケーションがあるのでいいけど、0から始める場合はまずアプリケーションの登録から。 Welcome to Google App Engine まずダッシュボードで適当にアプリケーション作成。アプリケーション作ったらSDKをダウンロード $ wg
SphinxでかんたんePubファイル作成
警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 日時: 2010/05/21 作者: 渋川よしき 最終更新: 2021/02/12 Sphinxの1.0からは、ePubファイルのビルドができるようになります。ePubファイルというのは、iPadやソニーの電子ブックリーダーなどで利用できる、電子ブックのフォーマットです。原理的にはHTMLに、決まった形式のメタデータを含むファイルを追加して、zipで固めて拡張しをepubにしたものですが、Sphinxを使えば簡単に出力することができます。
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
Sphinx-Users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://dl.dropbox.com/u/218108/files/sphinx-reverse-dict/index.html
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア