渋日記: Pythonって何？という人のためのSphinxチュートリアル
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回、インストールのエントリーを書きましたが、Tornadeドキュメントの翻訳を例に、実際にSphinxでの作業の流れをお見せしたいと思います。 まずはワークフォルダを作る 作業をするには、ファイルを置く場所が必要です。ソースコード、設定ファイル、ビルド後の成果物などなど、いろいろ必要になります。そこでフォルダを作成する必要があります。僕の場合は翻訳とかの作業は(ホーム)/work/(作業フォルダ)という場所で行うことが多いので、その前提で話しをすすめます。Tornadoの翻訳の場合はチームで作業をしたので、bitbucketを使って共有環境を用意しましたのでその説明も一緒に。 共有をする場合はMercurialをインストールしてください。Windowsの場合はTortoise
Flaskってドキュメントの充実っぷりもいいよね - When it’s ready.
Flaskの公式サイトにドキュメントもアップれています。ver.0.51かつ出来てから間もないのにその充実度はかなりのものがあり大変ありがたく読ませてもらっています。さらに、ドキュメントはSphinxで生成されていて、ソースも簡単に入手出来たりします。 日本語ドキュメントが無いかなぁと思っていたのですが、なさそうなのと必要なので日本語化しています。@ymotongpooさんや@Masahito さんも協力してくれてコツコツやっております。ソースは、bitbucketでたまにアップデートしていきます。「Flaskいいよねぇ」「日本語化してぇなぁ」という協力していただける方がいればより早く完成に近づけると思うので、pullリクエストください。 リポジトリ http://bitbucket.org/a2c/a2c.bitbucket.org/ html http://a2c.bitbucket.
2009-12-06
追記 Sphinx-Users-JPの下記記事をがより詳細に。 SphinxでPDFファイル作成 ドキュメント生成ツールのSphinxがよさげ。なのだけど日本語PDFに苦戦したので投稿しとく。 環境 Fedora12 Python2.6.2（Fedora12に初期状態で入っている） Sphinx ドキュメント Sphinxについては渋川さんが翻訳されたドキュメントがある。 Sphinx - 渋川さん翻訳 Sphinx - Original http://pypi.python.org/pypi/Sphinx wget http://pypi.python.org/packages/source/S/Sphinx/Sphinx-0.6.3.tar.gz tar zxf Sphinx-0.6.3.tar.gz cd Sphinx-0.6.3 python setup.py installSph
Shibu's Diary: Sphinxでライブラリリファレンスを書くための新機能？
http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains Sphinxの開発者のGeorg Brandl氏が今日MLに投稿して明らかになった、新機能案。Sphinxはふつーの文書というよりは、ライブラリのリファレンスを書いたりする機能が充実していて、そちらで使われることを想定して開発されている(Pythonの標準ドキュメントで使われている)のですが、そこに大きく手が加わるかも、とのことです。今までは、関数の説明を書く時は、 .. function:: following(identifier) 関数の説明 とやっていたのですが、py:functionなど、言語指定ができるようになるみたいです。今まではPythonの場合はfunction、C言語の場合はcfunctionみたいにそれぞれ別のディレクティブだったんですが、他の言
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ページを開く
