Sphinxで文章を書く際のEmacs環境設定 2012.12版 - YAMAGUCHI::weblog
はじめに こんにちは、Python界の情弱です。このエントリはSphinx Advent Calendar 2012の2日目のエントリです。1日目の@r_rudiより受け取りました。完全に使い回しのネタ＋αとなってますがご容赦下さい。 Sphinx Advent Calendar 2012 - connpass 最近はVimだとかSublime Text 2だとか、若者のEmacs離れが進んでおりますが、みなさんはいかがお過ごしでしょうか。SphinxはreStructured Textでドキュメントを記述しますが、Emacsを使うと結構色々と便利だよ、という事をお知らせしたく、この文章を書いています。 rst.el rst.elの導入 Docutilsが配ってます。Emacs用の拡張しか置いてないです。 http://docutils.svn.sourceforge.net/svnroo
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
わかる！metadata.managedFields / Kubernetes Meetup Tokyo 48
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
Sphinxの国際化機能を使って複数言語用ドキュメントを用意する方法（概要） - 2011-05-31 - ククログ
YARDのことの続きを書きたいと思いつつもなかなか辿りつきません。今回はPython製のドキュメントツールSphinxの話です。groongaのケースを例にしてSphinxで複数言語用のドキュメントを生成する方法の概要を紹介します。書いていたら長くなったので、具体的にどうするかというのは次の機会にします。 5/29にgroonga 1.2.2がリリースされました。今後は日本だけではなく世界でも使ってもらえるように、英語でも情報を発信していく方向になりました。そこで、今回のリリースに合わせてサイトデザインをリニューアルし、英語のページも用意しました。ただし、すでにあった日本語のコンテンツを今回のリリースで全部英語にした、というものではありません。今回のリリースでやったのは「日本語と英語という複数の言語で情報を発信する仕組み」を作るところまでです。せっかくなので、今回のリリースで導入した、Sp
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の
海外で作られたPython製ノベルゲーム制作ツール、Ren'Pyのドキュメント日本語訳(途中)を仮公開しました！ - プログラマ行進曲第二章
昨日2/12(土)にオラクル青山センターで開かれた"Sphinx + 翻訳 Hack-a-thon 2011.02"というイベントに参加してきました。このイベントは「Sphinx」*1というPython製のドキュメント生成ツールと「翻訳」に興味がある人を対象にした勉強会で、色々思うところがあってこのたび参加してきました。何故参加したか？といったことや参加するに至った経緯は別のエントリでまとめて公開する予定なので、後で合わせてそちらも読んでいただければと思います。 前置きが長くなりましたが、本題です。あまりに長くなったので、要点だけ知りたい方は最後のまとめまでスキップしてください。 前述したイベント、"Sphinx + 翻訳 Hack-a-thon 2011.02"で私はRen'PyというPython製ノベルゲーム制作ツールのドキュメントを翻訳しようと思って参加しました。そしてイベント参加者
Welcome to git-sphinx’s documentation! — git-sphinx v1.0 documentation
概要¶ ドキュメントの作成、編集から出力・公開の一気通貫を考えてみる (gollum + GitHub + Sphinx)。 入力UI Wiki(local: gollum / global: GitHub wiki) エディタ(vi, Emacsなど) バージョン/構成管理: reST & git 出力: Sphinx: HTML/PDF/ePUB + WebServer 今回は、origin server は省略して、GitHub の WiKi を origin にしてみる (手抜き) 一般展開への課題¶ gollum reST の suffix が .rest ( Sphinx 側設定を .rest にして回避中) シンプルで良いが、シンプルすぎる Webからの新規ページ作成の動線が無い 名前空間がフラットでディレクトリの概念がないためpukiwikiユーザには受け入れられにくい。
Shibu's Diary: Pythonって何？という人のためのSphinxチュートリアル[2]
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 シリーズものの記事の第3弾です。さて、それではSphinxならではのディレクティブをいくつか使っていきます。また、それ以外にも、前回ので書き忘れたreSTなんかも補足していきます。トップ画像が代わり映えしなくて済みません。 Pythonって何？という人のためのSphinxインストール入門 Pythonって何？という人のためのSphinxチュートリアル 前回書き忘れていた分 画像の挿入 ものすごく簡単です。 .. image:: tornado.png これだけ。ファイルは、相対パスで指定します。上記の書き方をすると、そのファイルがあるのと同じフォルダを探索します。絶対パス/tornado.pngと書くとどうなるかというと、ソースコードの置いてあるルートのフォルダを起点に探索しま
Sphinxクックブック
Sphinxクックブック¶ Sphinxクックブックでは、Sphinxの活用方法、Tips集、Sphinx拡張開発に関する話題を取り上げていきます。 もし何かあれば、メーリングリスト、 Twitterで@sphinxjp宛につぶやく などで情報を出してもらえれば、どんどん載せていきます。
ドキュメントの翻訳にSphinxを使う (i18n非利用)
ドキュメントの翻訳にSphinxを使う (i18n非利用)¶ author: 渋川 date: 2010/04/18 オープンソースのソフトウェアのドキュメントの翻訳や、ブログなどの翻訳をやったことがあるのであれば、日本語と英語をどのように管理していくのか、というのは、地味に面倒な問題です。 dokuwiki のように、切り替え機能を内蔵したシステムもありますが、見比べながら訳すのがやりにくかったり、テキストファイルでないので、管理が自由にできないという問題もあります。 Sphinxが使っているreStructuredTextにはコメントアウト機能があるので、気軽に翻訳が行えます。ただし、dokuwikiのように、日本語、英語、中国語、ドイツ語・・・など複数言語を一度に扱うのは難しいです。 注釈 Sphinxにi18n機能が入る前から利用していたワークフローです。i18n機能を利用したti
SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python：楽天ブログ
2008.03.23 SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト (317) テーマ：プログラミング言語 Python を使う(336) カテゴリ：Python SPHINX: PYTHON DOCUMENTATION GENERATOR を見る。SPHINX は、Georg Brandl 氏によって作られた Python プロジェクトのドキュメントを生成してくれるプログラム。reStructuredText のソースを HTML、Windows HTML Help、LaTeX、PDF といった出力形式で出力してくれる。reStructuredText のパースは、Docutils を使っているようだ。元は、Python Documentation のために作られて、他でも使えるように、きれいに書き直されたもののようだ。 対象となるのは、基本的に
渋日記: 1日〜1週間のでOSSに貢献する方法
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 OSC 2009 Tokyo/FallのLTで発表してきました。ACアダプタを忘れて、Windows PCで発表する予定だったのを、バッテリー持ちの良いMacBookにスイッチ。また、当日はPloneのブースで山本烈さんにアダプタをお借りしました。「電源とRGBケーブルありますよ！」とmixiを見てダイレクトメッセージを送ってくれた清水川さんともども、感謝申し上げます。 なぜかトリだったのですが、トラブルがあってその前に。タイマーが無かったのでiPod Touchの時計を表示しながら話していましたが、省電力設定がONのままだったので、ちょくちょくロックがかかってしまったのは失敗でした。今度から気をつけよう。 今回は話す内容がほぼそのままスライドになっているので補足するところは少
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 色設定について詳しく説明
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://dl.dropbox.com/u/218108/files/sphinx-reverse-dict/index.html
ドキュメントを作りたくなってしまう魔法のツールSphinx
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
Gooroo | All-in-One Learning with Online Courses and Tutoring