タグ

Sphinxに関するp260-2001fpのブックマーク (15)

  • Redmine Sphinx Pluginの概要 - nishio-dens's diary

    機能 Redmine上でのSphinxドキュメントの表示 リポジトリにアップロードされたSphinxドキュメントの自動コンパイル 注意事項 プラグインを利用するためには、あらかじめRedmine上でプロジェクトの作成、およびリポジトリの設定を行っておく必要があります リポジトリ内のSphinx Makefileを検索し、makeを行うことで、ドキュメントのコンパイルをしています。 Makefileが存在しない場合は、Sphinxドキュメントを正しく表示することができません。 現状では、GitとSubversionリポジトリ以外には対応していません プラグインの使い方 プラグインをインストールすると、SphinxドキュメントのタブがRedmineプロジェクトメニューバー上に表示されます(図1)。 図1: プロジェクトメニューバー上に追加されたSphinxドキュメントタブ Sphinx

  • ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会

    システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって

    ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
    p260-2001fp
    p260-2001fp 2011/06/19
    blockdiagどんどん成長してる。すごいなー。ただSphinxも含めてWYSIWYGエディタがないと普及は…(TracからRedmineに移行できない理由の一つ)
  • platex経由でPDFを生成する。 - kuma8の雑記帳

    はじめに Sphinx 1.0.6 から platex経由で日語を含むPDFが出力できるようになりました。 以前は、LaTeX経由でのPDF作成のように、いろいろと手を入れる必要がありました。 まだ利用方法のドキュメントが無いため紹介します。 platex経由でのPDF作成 まず、platexが利用できる環境を用意します。 TexLive2010 で利用できることを確認できているので、TexLive2010以降をおすすめします。 次に、サンプルのプロジェクトを作成します。細かい手順は、http://sphinx-users.jp/gettingstarted/index.html Sphinxをはじめようを見るとわかりやすいです。 ここまでで、サンプルのプロジェクトができあがっているので、platex経由でPDFが出力できるようにします。 まず、 conf.py の設定を変更します。 次

    platex経由でPDFを生成する。 - kuma8の雑記帳
  • Shibu's Diary: 検索エンジン改造して遊ぼう!

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 by efilpera under CC BY-NC-SA tk0miyaさんから、Python Web フレームワークアドベントカレンダーのパスが回ってきました。ちなみに当方、現在、The Art of Communityの翻訳直しが佳境なのと、技術研究所を辞めて転職することにしたのと、それに伴って引っ越しの準備やらで首がまったく回っていません。Pythonのアドベントカレンダーは、なぜか遅れるとバリカンという殺伐した話になっていて、恐怖で禿げそうです。あ、退職の話は年末に落ち着いたら書くかも。 今回のネタは、僕がユーザグループの会長をやっている、Sphinxのお話にしようと思います。Sphinxに関しては、@r_rudiさんが実用系の話を既に書いてくださっていますので、

  • Powered by Google ドキュメント

    ログイン

    Powered by Google ドキュメント
  • 「日本語でSphinxを使う時のストレスを減らす拡張機能」を試す - hokorobi’s diary

    渋日記: 日語でSphinxを使う時のストレスを減らす拡張機能 http://blog.shibu.jp/article/40049067.html 拡張を追加するところから初めてなので、Sphinx拡張 - Sphinx v1.1 (hg) documentation http://sphinx-users.jp/doc10/extensions.html を見ながら。 プロジェクトに exts ディレクトリを追加。 exts に japanesesupport.py として、コードを貼り付け。 conf.py に sys.path.append(os.path.abspath('exts')) を追加して、extentions に 'japanesesupport' 追加して make pdf 。 リンク前後の空白はなくなったけれど、文がページ外まで伸びていくようになってしまった……

    「日本語でSphinxを使う時のストレスを減らす拡張機能」を試す - hokorobi’s diary
  • Sphinx で PDF 作成 #sphinxjp - hokorobi’s diary

    インストール 画像を入れたいので、Python Imaging Library (PIL) http://www.pythonware.com/products/pil/ もインストール。http://effbot.org/downloads/PIL-1.1.7.win32-py2.6.exe をダウンロードして実行。 rst2pdf - Project Hosting on Google Code http://code.google.com/p/rst2pdf/ から rst2pdf-0.16.tar.gz をダウンロードして python setuo.py install http://code.google.com/p/rst2pdf/source/browse/trunk/doc/manual.txt を見ながら設定。 make.bat make pdf 用のコードを追加。 co

    Sphinx で PDF 作成 #sphinxjp - hokorobi’s diary
  • Sphinx で日本語の検索 #sphinxjp - hokorobi’s diary

    渋日記: Sphinx日語検索対応の1.0版 http://blog.shibu.jp/article/40995746.html で提供されている Sphinx には検索ができないバグがあるので、とりあえず動くようにしてみた。 ちゃんとした修正は渋川さんがしてくれるはずなので、場つなぎ的に。 検索を動かすためにやったことは、sphinx\themes\basic\static\searchtools.js_t に sphinx\themes\basic\static\searchtools.js の loadIndex を追加して、console.debug, console.info をコメントアウトしただけ。 深く考えずに大元に加えられた変更もマージした。 また、2 文字以下の単語が検索対象から除外されていたので、マルチバイト文字なら 1 文字でも検索対象とするように変更したつもり

    Sphinx で日本語の検索 #sphinxjp - hokorobi’s diary
  • Shibu's Diary: oreilly2sphinx

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 taken by caribb under CC BY-NC-ND 動物と言えばオライリー。オライリーと言えば動物。良質な洋書を翻訳したが多く(書き下ろしもあります)、品質は折り紙付きな出版社です。オライリーのに接する人は大きく二つに分かれると思います: を読む人 洋書を翻訳する人 このブログで紹介するスクリプトは、後者の人で、尚かつ翻訳にSphinxを使うよ!というレアな人向けです。適当に作ってみたのですが、便利そうなので公開します。テストは手元にあったThe Art of Community とErlang Programming の2冊で行っています。どっちも良いです。 Sphinxを使ってオライリーの翻訳をされる方はご利用ください。 使い方 使う時はまず、

  • はてなブログ | 無料ブログを作成しよう

    来年も作りたい!ふきのとう料理を満喫した 2024年春の記録 春は自炊が楽しい季節 1年の中で最も自炊が楽しい季節は春だと思う。スーパーの棚にやわらかな色合いの野菜が並ぶと自然とこころが弾む。 中でもときめくのは山菜だ。早いと2月下旬ごろから並び始めるそれは、タラの芽、ふきのとうと続き、桜の頃にはうるい、ウド、こ…

    はてなブログ | 無料ブログを作成しよう
  • Shibu's Diary: Sphinxの翻訳が完了しました

    8月ぐらいから取り組んでいたSphinxの日語訳がほぼ完了しました。一部間違い発見したのをIssue Trackerにいれたのを修正待ちだったり、分からないところをMLに聞いていたり、LaTeXのオプションが未訳だったりするけど、まぁ一旦ここでクローズ。 Docutils体もそうだけど、Sphinxの拡張機能は色々ユメが広がる感じです。ディレクティブとロールを自分で作るだけでも、ドキュメントのレベルを一歩先に進めてくれそうですし。WebアプリケーションのURLとアクションとか、Web APIとか、クロスリファレンスできるとうれしいモノっていっぱいあるよね。 次はSphinxの拡張機能を色々やりたいね。youtubeディレクティブとか作りたいなぁ、なんて思っています。Docutilsの知識とかもいろいろ必要になってくるけどね。

  • Shibu's Diary: Sphinxについていろいろ考え中・・・

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxについていろいろ考え中です。ツールとしてのすばらしさは申し分なく、いろいろ夢が広がりすぎて困ってしまうぐらいです。悩んでいるテーマは2つ。 Sphinx hack-a-thon @aohtaから、公式ハッシュタグについてのアナウンスもあった、Sphinx hack-a-thon。偶然、同日に同じ会場でやることになっている、Python hack-a-thonと共同開催です。やる内容はこんな感じかな、と思っています。 ハンズオン Sphinxをインストールしてみて、料理レシピか何かのドキュメントを作ってみよう!という30分~50分程度のハンズオン。参考資料は↓このあたり。手前味噌だけど。@MiCHiLUがPDF出力とか説明してくれたりするかな!? Sphinxドキュ

  • Shibu's Diary: とちぎRuby会議02 - その2(LTディレクターズカット版)

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回のエントリーでは、とちぎRuby会議02で発表した資料を公開したのですが、時間の都合でカットした分を公開します。死蔵しても意味ないしね。まさにディレクターズカット版です。というか、カットした部分だけ。どちらかというと、文章の書き方渋川流メソッドなので、内容的にはこちらの方が「儲かるRuby」という今回のテーマには近い気がしたけど、どうしてもアジャイルについて入れたかったのと、江渡さん栃木上陸記念を入れたかったので、こちらをカットしました。イテレーティブなドキュメンテーションとかの話しはここでの話しを飛ばしてしまうと、編で唐突な印象だったんじゃないかな、とは思いますが・・・ 儲かるドキュメントを書く場合に、何をどう書いていけばいいのか、という話しをします。まだ考え中の部分な

    p260-2001fp
    p260-2001fp 2009/10/26
    『開発を加速させるドキュメンテーション』『文章も コードと一緒 イテレーション』会話、チャット等一度アウトプットしてから文章に落とす。『コードにはHowを、テストにはWhatを』
  • Shibu's Diary: とちぎRuby会議02 - その1(LT)

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 とちぎRuby会議02がありました!普段は技術や「普及するには?」ということについて語られることが多いIT系イベントですが、仕事としてのマインドについて多くのメッセージを聞くことができました。今回はその中でLTの発表をしてきましたので、スライドとスクリプト(時間の関係でかなり削りましたが)を公開します。裏切り者感たっぷりのスライドですが、最後までおつきあいください。 今回ご紹介したいものが、このSphinxです。 Wikiみたいなプレーンテキストの簡易マークアップから整形してくれるツールです。相互リンクも張ったり、索引を作ったりもしてくれる。LaTeXを経由しないPDF出力は現在活発に開発されている部分。これができるとかなり強力です。コードハイライトも、nginxというリバース

    p260-2001fp
    p260-2001fp 2009/10/26
    WikiとSphinxの比較、『Sphinxはドキュメント界のSUnitになれるのでは』『文芸的ユニットテスト』Sphinxは手書きのドキュメントと、自動作成のドキュメントを融合させるために作られた。
  • Shibu's Diary: Pythonって何?という人のためのSphinxインストール入門

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 この前のブログのエントリーにも書きましたが、Sphinxというステキすぎるツールがあります。ドキュメントがどんどん書きたくなっちゃうステキなツールです。ですが、残念ながら、使用するためにはインストールする必要があります。Pythonって何?という人には少々敷居が高いため、解説の記事を書いてみました。 [STEP 1] Pythonからインストールする場合 WindowsではPythonからインストールする必要があります。一発でインストールできる環境を持っている人は最後の方のインストール法に飛んでください。また、Mac OS Xみたいに、最初からPythonから入っている人は[STEP 1]は飛ばしてください。 Windwsの場合 http://python.orgを開きます。P

  • 1