Sphinx documentation on GitHub
The Data Desk often publishes documentation alongside its code on GitHub, a social networking site where developers share their work. GitHub’s main service — free for open-source projects — is for managing source code, but it also provides ticket tracking, wikis and a simple file-hosting service for publishing HTML pages. It’s that last trick that’s great for documentati
はてなダイアリーを止めてSphinxに移行した話 — HOME
はてなダイアリーを止めてSphinxに移行した話¶ せっかく新しい会社に就職できたので思い切って日記をSphinxベースに変更してみました。 Sphinxってナニ？¶ SphinxはPythonで作られたドキュメント生成エンジンみたいなもので PHP界隈ではSymfony2やOpenPNEのドキュメント作成に使われています。 書き方がreStructuredTextを拡張したものでテキストそのままの状態でも 見やすいですし、様々なフォーマットに変換できるメリットがあります。 ドキュメントを作成してWeb上で公開するのが普通の使い方ですが、Sphinx 使って静的なWebサイトを構築してしまいましょう。
Shibu's Diary: shibu.jpをSphinxでリニューアル
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 shibu.jpのリニューアルを行いました。デザイン上は変わっていませんけどね。ようやく、出した本の情報を載せて、「僕の書いた本のタイトルはshibu.jpを見てください」と言えるようになりました。 このブログも、http://www.shibu.jpも、http://www.oswd.org/にあったテンプレートを利用させてもらっています。ブログの方も、このテンプレートのcssや画像を全部アップして、これに合うように、HTMLの構造やら、idやらclassやらを手で合わせていきました。結構手間かかった記憶があります。 今回のshibu.jpの方の改修は、ファイル一式をコピーして、Sphinxの新テーマを作ります。Sphinx-Users.jpにある、Sphinxのテーマの作成
Shibu's Diary: Sphinxについていろいろ考え中・・・
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxについていろいろ考え中です。ツールとしてのすばらしさは申し分なく、いろいろ夢が広がりすぎて困ってしまうぐらいです。悩んでいるテーマは２つ。 Sphinx hack-a-thon @aohtaから、公式ハッシュタグについてのアナウンスもあった、Sphinx hack-a-thon。偶然、同日に同じ会場でやることになっている、Python hack-a-thonと共同開催です。やる内容はこんな感じかな、と思っています。 ハンズオン Sphinxをインストールしてみて、料理のレシピか何かのドキュメントを作ってみよう！という30分～50分程度のハンズオン。参考資料は↓このあたり。手前味噌だけど。@MiCHiLUがPDF出力とか説明してくれたりするかな！？ Sphinxドキュ
Shibu's Diary: Sphinxの検索を日本語対応にする
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 写真は内容とは関係なく、栃木県宇都宮市のスフィンクスです。闇夜にいきなり現れるとかなりコワイです。 Sphinxの検索機能の日本語対応をしてみました。リンク先にはパッチ済みのSphinxが置いてあります。Sphinxは検索関連に関しては、かなり英語にハードコードされていましたので。やったことは以下の通り。 日本語対応のSplitterの作成 設定オプションに検索言語切り替えを追加 stemmingアルゴリズム、 stop wordsも検索言語と連動して切り替わるように変更 Sphinx-devのメーリングリストに、機能拡張要望をメール 日本語対応のSplitterの作成 まずやってみたのはSplitterの作成。Sphinxでは欧米言語を想定しているので、re.compile(
Shibu's Diary: Pythonって何？という人のためのSphinxチュートリアル[2]
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 シリーズものの記事の第3弾です。さて、それではSphinxならではのディレクティブをいくつか使っていきます。また、それ以外にも、前回ので書き忘れたreSTなんかも補足していきます。トップ画像が代わり映えしなくて済みません。 Pythonって何？という人のためのSphinxインストール入門 Pythonって何？という人のためのSphinxチュートリアル 前回書き忘れていた分 画像の挿入 ものすごく簡単です。 .. image:: tornado.png これだけ。ファイルは、相対パスで指定します。上記の書き方をすると、そのファイルがあるのと同じフォルダを探索します。絶対パス/tornado.pngと書くとどうなるかというと、ソースコードの置いてあるルートのフォルダを起点に探索しま
渋日記: Pythonって何？という人のためのSphinxチュートリアル
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回、インストールのエントリーを書きましたが、Tornadeドキュメントの翻訳を例に、実際にSphinxでの作業の流れをお見せしたいと思います。 まずはワークフォルダを作る 作業をするには、ファイルを置く場所が必要です。ソースコード、設定ファイル、ビルド後の成果物などなど、いろいろ必要になります。そこでフォルダを作成する必要があります。僕の場合は翻訳とかの作業は(ホーム)/work/(作業フォルダ)という場所で行うことが多いので、その前提で話しをすすめます。Tornadoの翻訳の場合はチームで作業をしたので、bitbucketを使って共有環境を用意しましたのでその説明も一緒に。 共有をする場合はMercurialをインストールしてください。Windowsの場合はTortoise
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
Shibu's Diary: Sphinxのドキュメントの日本語訳しました
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxドキュメント日本語訳 ドキュメントを作成したくなってしまう魔法のツール、Sphinxのドキュメントを日本語訳しました。普通に使う分には問題ない、レベルまで完了しました。残る部分もぼちぼちやっていきますが、拡張機能の部分は最後まで手を付けないと思うので、自分で拡張したい方はがんばって英語(とソースコード)を読んでください。 reStructeredText(reST)採用で、HTMLやPDFが作成できる reSTを拡張して様々な記述が簡単できるようになっている。コードハイライト、BNF、モジュール、クラス、関数などのソースコードのドキュメンテーションなど 1ファイル変換ではなくて、複数ソースの"プロジェクト"として管理できて、ドキュメント間リンクの面倒を見てくれる。
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - pat/thinking-sphinx: Sphinx/Manticore plugin for ActiveRecord/Rails
はてなブログ | 無料ブログを作成しよう