Sphinx ではどのようにラベルとキャプションを結びつけているのか - Hack like a rolling stone
Sphinx ではラベル記法と :ref: 記法を使って、 ドキュメントの様々な位置にラベルを張り、それを参照することができます。 .. _target: section --------- セクションへの :ref:`参照 <target>` を作ります。 さて、このとき、ラベルを貼っているのがセクションタイトルなどの場合は :ref:`target` という書き方でキャプションをリンクタイトルにすることができます。 ラベルとキャプションを認識する Sphinx は次の順序でラベルを認識します。 reST ファイルのパース処理において、ラベル記法をパターンマッチで見つける (docutils.parsers.rst.states:Body#explicit_construct()) target ノードを生成する (docutils.parsers.rst.states:Body#mak
国際化 — Sphinx 1.4.4 ドキュメント
Sphinxでは、ナビゲーションバーなどの文字列を各国語にする機能を提供していましたが、 文章 そのものを翻訳する機能を提供します。細かい設定については 国際化のオプション を参照してください。 Sphinx 国際化について¶ gettext [1] は国際化とローカル化の手段として、よく使用されている方法です。プログラム中で使用されるメッセージと、翻訳文字列の対応表を使って置き換えてきます。Sphinxはこの機能を使って、ドキュメント全体を翻訳していきます。 まず最初に、プロジェクトのメンテナーはすべての翻訳文字列を集めてくる必要があります(これを メッセージ と呼ぶ)。これを翻訳者に渡します。Sphinxでは、 sphinx-build -b gettext を実行して、これを行います。 すべてdoctreeの要素は、それぞれがメッセージとなります。巨大なパラグラフは原文のまま残ります
Sphinx の文書を翻訳してみよう (gettext機能) - 2011-12-03 - Hack like a rolling stone
こんばんは、Sphinx & blockdiag アドベントカレンダー 3日目です。 今日は Sphinx 1.1 で実装された gettext 機能をご紹介します。 gettext は多言語に対応したアプリケーションを開発するときに利用する API で、 メニューに表示される単語やエラーメッセージなどを利用言語ごとに置き換える仕組みを提供しています。 gettext を利用することで翻訳元のドキュメントファイルを変更することなくドキュメントの翻訳を行い 他の言語(日本語や中国語など)のドキュメントを生成することができます。 概要 Sphinx では .rst ファイルに書かれた文章を言語ごとに置き換えることができます。 最初に英語でドキュメントを書き、gettext を介して翻訳を行うことで複数の言語のドキュメントを作ることができます。 gettext では中間ファイルとして pot フ
はてなブログ | 無料ブログを作成しよう
来年も作りたい！ふきのとう料理を満喫した 2024年春の記録 春は自炊が楽しい季節 1年の中で最も自炊が楽しい季節は春だと思う。スーパーの棚にやわらかな色合いの野菜が並ぶと自然とこころが弾む。 中でもときめくのは山菜だ。早いと2月下旬ごろから並び始めるそれは、タラの芽、ふきのとうと続き、桜の頃にはうるい、ウド、こ…
LaTeX経由でのPDF作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
Sphinxの標準機能に、LaTeXを経由したPDF出力が入っています。英語の文章であれば簡単に成功しますが、日本語ではスムーズに行かないところもあります。 ここでは日本語ならではの情報を集約します。 Sphinx で利用する TeXディストリビューション¶ Sphinx で日本語文章を書く場合は文字コードに UTF-8が利用されるため、PDF を作成する際には UTF-8 対応版の pLaTeX である必要があります。内部では ebb, mendex, platex, dvipdfmx の各コマンドを利用していますので、これらが利用できる環境を用意します。 ここでは、Windows、OSX、Linux、FreeBSDなどに対応しており、環境の作りやすさを考慮して、TeX Liveというディストリビューションを使って説明をしていきます。
Overview — Sphinx v1.0.6 documentation
A project Download 現在のバージョン: 1.4.4 Python Package Indexからソースコードをダウロードするか、以下のコマンドでインストールしてください: pip install -U Sphinx 疑問? 意見? Googleグループのsphinx-users グループへの参加 もしくは、FreeNodeの#sphinx-docチャンネルへどうぞ。 何か気づいたことがあれば、issue trackerを使用して報告することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinx-contrib/omegat at master · thewtex/sphinx-contrib
http://atnd.org/events/22450
Windows上でCodeigniterのユーザガイドをMakeする手順
sphinx i18n
Sphinx 1.1 i18n 機能紹介
PHP Domain — sphinxcontrib-phpdomain 0.1 documentation
ドキュメントを作りたくなってしまう魔法のツールSphinx