タグ

sphinxに関するstarsky5のブックマーク (5)

  • 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

  • sh1.2 pyblosxom : sphinxを使ってみた

    これまでは、reStructuredTextで書いたテキストをhtml形式にしたい場合には、 rst2html.pyを使ってた。ただこれだと見栄えを良くしようと思ったら自分でcssファイル をいじってごちゃごちゃとしないといけなかったので結構面倒くさかった。 sphinxなら見栄えのいいcssと、javascriptによる検索機能までついてくるし、コードハ イライトまでしてくれる。v0.3使用。 Overview phinx v0.3 documentation Pyxis のドキュメント生成 - Pyxis 開発ブログ SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python - 楽天ブログ(Blog) 詳しくは上のリンクに書いてあるんだけど、sphinx-quickstartを実行すると、index.txt が作成され、下記の

  • 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や、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ

  • Shibu's Diary: Sphinxのドキュメントの日本語訳しました

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxドキュメント日語訳 ドキュメントを作成したくなってしまう魔法のツール、Sphinxのドキュメントを日語訳しました。普通に使う分には問題ない、レベルまで完了しました。残る部分もぼちぼちやっていきますが、拡張機能の部分は最後まで手を付けないと思うので、自分で拡張したい方はがんばって英語(とソースコード)を読んでください。 reStructeredText(reST)採用で、HTMLPDFが作成できる reSTを拡張して様々な記述が簡単できるようになっている。コードハイライト、BNF、モジュール、クラス、関数などのソースコードのドキュメンテーションなど 1ファイル変換ではなくて、複数ソースの"プロジェクト"として管理できて、ドキュメント間リンクの面倒を見てくれる。

  • SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python:楽天ブログ

    2008.03.23 SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト (317) テーマ:プログラミング言語 Python を使う(336) カテゴリ:Python SPHINX: PYTHON DOCUMENTATION GENERATOR を見る。SPHINX は、Georg Brandl 氏によって作られた Python プロジェクトのドキュメントを生成してくれるプログラム。reStructuredText のソースを HTMLWindows HTML Help、LaTeXPDF といった出力形式で出力してくれる。reStructuredText のパースは、Docutils を使っているようだ。元は、Python Documentation のために作られて、他でも使えるように、きれいに書き直されたもののようだ。 対象となるのは、基的に

    SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python:楽天ブログ
  • 1