sphinx

github pages に Sphinx で生成したドキュメントを公開する。

Github Pages にSphinxで生成したドキュメントを公開するほうほうです。Github Pages では各リポジトリごとにプロジェクトページを作成することができます。 各プロジェクトごとにページを作成することでマニュアルなどの公開が便利にできます。Sphinx で生…

Sphinx で Google Analytics を利用する。

Sphinx で Google Analytics をトラックするスクリプトを埋めるのは どうすればいいんだろと思っていたら、 sphinx-contrib にプラグインが 公開されていました。 sphinxcontrib-googleanalytics https://bitbucket.org/birkenfeld/sphinx-contrib/src/bb0b2…

platex経由でPDFを生成する。その2

前回の内容では、Sphinx プロジェクト内に画像ファイルが無いとエラーになってしまいました。 その現象は、すでに本家のレポートとして報告されています。そのパッチを参考に以下のようにすると、画像ファイルが無い場合にもエラーとならずPDFが作成できます…

platex経由でPDFを生成する。

はじめに Sphinx 1.0.6 から platex経由で日本語を含むPDFが出力できるようになりました。 以前は、LaTeX経由でのPDF作成のように、いろいろと手を入れる必要がありました。まだ利用方法のドキュメントが無いため紹介します。 platex経由でのPDF作成 まず、p…

erlang-domainを使ってみた。

Sphinx 1.0 からドメイン機能*1が追加されましたが、@shibukawaさんが、erlang-domain*2を公開されたので使ってみました。erlang-domainを使うことで、きれいにマークアップされたErlangドキュメントを書くことができます。1. まずは、インストールから $ ea…