1. Nozomu Kaneko
  2. sphinxjp doc11

Commits

SHIBUKAWA Yoshiki  committed bf83da8

finish pre 1.1 translation

  • Participants
  • Parent commits 57fe22c
  • Branches default

Comments (0)

Files changed (16)

File docjp/domains.rst

View file
 
 ``~`` と ``.`` をオブジェクトの識別子の前に組み合わせることができます。 ``:py:meth:`~.TarFile.close``` と指定されると、 ``tarfile.TarFile.close()`` が参照されますが、実際に文章中に表示されるのは、 ``close()`` となります。
 
-.. _c-roles:
 
 .. The C Domain
    ------------
 .. Cross-referencing C constructs
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. _c-roles:
+
 C言語の要素へのクロスリファレンス
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 .. These roles are provided to refer to the described objects:
 
+.. _js-roles:
+
 このドメインでは、オブジェクトの説明を参照する、次のようなロールが提供されています:
 
 .. rst:role:: js:func
 
 .. These roles are provided to refer to the described objects:
 
-.. _rst-roles::
+.. _rst-roles:
 
 説明したオブジェクトを参照するために、次のようなロールが提供されます:
 

File docjp/intro.rst

View file
 前提条件
 --------
 
-.. Sphinx needs at least **Python 2.4** to run, as well as the docutils_ and
-   Jinja2_ libraries.  Sphinx should work with docutils version 0.5 or some
-   (not broken) SVN trunk snapshot.  If you like to have source code highlighting
-   support, you must also install the Pygments_ library.
+.. Sphinx needs at least **Python 2.4** or **Python 3.1** to run, as well as the 
+   docutils_ and Jinja2_ libraries.  Sphinx should work with docutils version 0.5 
+   or some (not broken) SVN trunk snapshot.  If you like to have source code 
+   highlighting support, you must also install the Pygments_ library.
 
-Sphinxおよび、 docutils_, Jinja2_ などのライブラリの実行には **Python 2.4** よりも新しいバージョンのPythonが必要です。Sphinxが依存しているコンポーネントとしては、docutilsのバージョン 0.5、もしくはSVNリポジトリのTrunkのスナップショット(壊れていないものに限定)があります。もしもソースコードハイライトのサポートが必要であれば、 Pygments_ ライブラリも一緒にインストールする必要がありますが、setuptoolsのeasy_installを使用して、インストールすることができます。
+Sphinxおよび、 docutils_, Jinja2_ などのライブラリの実行には **Python 2.4** よりも新しいバージョンのPython、もしくは **Python 3.1** が必要です。Sphinxが依存しているコンポーネントとしては、docutilsのバージョン 0.5、もしくはSVNリポジトリのTrunkのスナップショット(壊れていないものに限定)があります。もしもソースコードハイライトのサポートが必要であれば、 Pygments_ ライブラリも一緒にインストールする必要がありますが、setuptoolsのeasy_installを使用して、インストールすることができます。
 
+.. If you use **Python 2.4** you also need uuid_.
+
+もしも **Python 2.4** を使用する場合には、 uuid_ をインストールしてください。
+
+.. The given homepage is only a directory listing so I'm using the pypi site.
  
 .. _reStructuredText: http://docutils.sf.net/rst.html
 .. _docutils: http://docutils.sf.net/
 .. _Jinja2: http://jinja.pocoo.org/2/
 .. _Pygments: http://pygments.org/
-
+.. 与えられたホームページは単なるリストです。私はPyPIサイトを使用しています。
+.. _uuid: http://pypi.python.org/pypi/uuid/
 
 .. Usage
    -----

File docjp/invocation.rst

View file
    .. Build a single HTML with the whole content.
 
    **htmlhelp**, **qthelp**, **devhelp**, **epub**
-      フォーマットごとに、ドキュメントのコレクションを構築するのに必要な情報と一緒にHTMLファイルビルドします。
+      フォーマットごとに、ドキュメントのコレクションを構築するのに必要な情報と一緒にHTMLファイルビルドします。
 
    .. Build HTML files with additional information for building a documentation
       collection in one of these formats.
 
    **latex**
-      :program:`pdflatex` を使用して、PDFドキュメントにコンパイルできるような、LaTeXのソースビルドします。
+      :program:`pdflatex` を使用して、PDFドキュメントにコンパイルできるような、LaTeXのソースビルドします。
 
    .. Build LaTeX sources that can be compiled to a PDF document using
       :program:`pdflatex`.
 
    .. Build manual pages in groff format for UNIX systems.
 
+   **texinfo**
+      :program:`makeinfo` を使ってInfoファイルを生成するための、Texinfoファイルにビルドします。
+
+   .. Build Texinfo files that can be processed into Info files using
+      :program:`makeinfo`.
+
    **text**
       プレーンテキストファイルをビルドします。
 
    .. Build plain text files.
 
+   **gettext**
+      gettextスタイルのメッセージカタログ(``.pot`` ファイル)にビルドします。
+
+   .. Build gettext-style message catalogs (``.pot`` files).
+
    **doctest**
       もしも :mod:`~sphinx.ext.doctest` 拡張が有効になっている場合には、ドキュメント内のすべてのdoctestを実行します。
 

File docjp/markup/index.rst

View file
 Sphinxマークアップ集
 ====================
 
-.. Sphinx adds a lot of new directives and interpreted text roles to standard reST markup.  This section contains the reference material for these facilities.
+.. Sphinx adds a lot of new directives and interpreted text roles to `standard reST markup`_.  This section contains the reference material for these facilities.
 
-Sphinxは標準のreSTに対して、数多くの新しいディレクティブとテキストの解釈を追加しています。このセクションでは、これらのサポート機能のリファレンスを提供します。
+Sphinxは `標準のreSTマークアップ`_ に対して、数多くの新しいディレクティブとテキストの解釈を追加しています。このセクションでは、これらのサポート機能のリファレンスを提供します。
 
 .. toctree::
 
    code
    inline
    misc
+
+.. More markup is added by :ref:`domains`.
+
+:ref:`domains` でこれ以外のマークアップが追加されます。
+
+.. 
+   .. _standard reST markup: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
+
+.. _標準のreSTマークアップ: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

File docjp/markup/inline.rst

View file
 
   HTML出力時には、リンクの ``title`` アトリビュート(マウスを上に持って行ったときにツールチップとして表示されるテキスト)には、常に、完全な参照対象の名前が設定されます。
 
+.. Cross-referencing objects
+   -------------------------
+
+オブジェクトのクロスリファレンス
+---------------------------------
+
+.. These roles are described with their respective domains:
+
+これらのロールは、それぞれのドメインの中で説明されています。
+
+* :ref:`Python <python-roles>`
+* :ref:`C <c-roles>`
+* :ref:`C++ <cpp-roles>`
+* :ref:`JavaScript <js-roles>`
+* :ref:`ReST <rst-roles>`
 
 .. Cross-referencing arbitrary locations
 
    ``example.py`` ファイルは出力ディレクトリにコピーされ、適切なリンクが生成されます。
 
 
+.. Cross-referencing other items of interest
+   -----------------------------------------
+
+他の要素へのクロスリファレンス
+------------------------------
+
+.. The following roles do possibly create a cross-reference, but do not refer to 
+   objects:
+
+以下のロールはクロスリファレンスを作成しますが、特定のオブジェクトを参照しません。
+
+.. rst:role:: envvar
+
+   .. An environment variable.  Index entries are generated.  Also generates a link 
+      to the matching :rst:dir:`envvar` directive, if it exists.
+
+   環境変数です。エントリーのインデックスが作成されます。もし :rst:dir:`envvar` ディレクティブがあれば、それへのリンクが作成されます。
+
+
+.. rst:role:: token
+
+   .. The name of a grammar token (used to create links between 
+      :rst:dir:`productionlist` directives).
+
+   文法のトークンの名前です。 :rst:dir:`productionlist` ディレクティブ内の定義との間でリンクが作成されます。
+
+
+.. rst:role:: keyword
+
+   .. The name of a keyword in Python.  This creates a link to a reference label 
+      with that name, if it exists.
+
+   Pythonのキーワード名です。もし存在していれば、この名前を持つ参照ラベルとの間にリンクが作成されます。
+
+
+.. rst:role:: option
+
+   .. A command-line option to an executable program.  The leading hyphen(s) must 
+      be included.  This generates a link to a :rst:dir:`cmdoption` directive, if it 
+      exists.
+
+   実行ファイルのコマンドラインオプションです。前に付くハイフンも含める必要があります。 :rst:dir:`cmdoption` ディレクティブで定義されていれば、リンクを作成します。
+
+
+.. The following role creates a cross-reference to the term in the glossary:
+
+以下のロールは用語集との間にクロスリファレンスを作成します:
+
+.. rst:role:: term
+
+   .. Reference to a term in the glossary.  The glossary is created using the
+      ``glossary`` directive containing a definition list with terms and
+      definitions.  It does not have to be in the same file as the ``term`` markup, 
+      for example the Python docs have one global glossary in the ``glossary.rst`` 
+      file.
+
+   用語集の用語への参照。用語集は ``glossary`` ディレクティブを使用して定義します。用語集と ``term`` マークアップは同じファイルにある必要はありません。例えばPythonのドキュメントは一つの用語集の ``glossary.rst`` というファイルの中にすべての用語の定義が書かれています。
+
+   .. If you use a term that's not explained in a glossary, you'll get a warning 
+      during build.
+
+   もしも、用語集の中で説明されていない用語がある場合には、ビルド時に警告が出力されます。
+
+
 .. Other semantic markup
-.. ---------------------
+   ~~~~~~~~~~~~~~~~~~~~~
 
 上記以外の意味のマークアップ
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. The following roles don't do anything special except formatting the text in a different style:
 
 .. rst:role:: samp
 
    .. A piece of literal text, such as code.  Within the contents, you can use 
-      curly braces to indicate a "variable" part, as in :rst:dir:`file` For
+      curly braces to indicate a "variable" part, as in :rst:role:`file` For
       example, in ``:samp:`print 1+{variable}```, the part ``variable`` would be
       emphasized.
 
-   リテラルのテキストの一部です。マークアップの内容の中には、 :rst:dir:`file` と同様に波括弧を使った"変数"を書くことができます。たとえば、 ``:samp:`print 1+{variable}``` というテキストがあると、 ``variable`` の部分が強調されます。
+   リテラルのテキストの一部です。マークアップの内容の中には、 :rst:role:`file` と同様に波括弧を使った"変数"を書くことができます。たとえば、 ``:samp:`print 1+{variable}``` というテキストがあると、 ``variable`` の部分が強調されます。
 
    .. If you don't need the "variable part" indication, use the standard 
       ````code```` instead.
 
    もし"変数部分"が不要であれば、標準の ````コード```` という形式を代わりに使用してください。
 
+.. There is also an :rst:role:`index` role to generate index entries.
 
+インデックスのエントリーを生成するための、  :rst:role:`index` ロールもあります。
 
 .. The following roles generate external links:
 
 
 このような目的を達成しようとしても、標準のreSTマークアップだけではハイパーリンクを取り込む特別なロールは存在しません。
 
-.. Cross-referencing other items of interest
-   -----------------------------------------
 
-他の要素へのクロスリファレンス
-------------------------------
-
-.. The following roles do possibly create a cross-reference, but do not refer to 
-   objects:
-
-以下のロールはクロスリファレンスを作成しますが、特定のオブジェクトを参照しません。
-
-.. rst:role:: envvar
-
-   .. An environment variable.  Index entries are generated.  Also generates a link 
-      to the matching :rst:dir:`envvar` directive, if it exists.
-
-   環境変数です。エントリーのインデックスが作成されます。もし :rst:dir:`envvar` ディレクティブがあれば、それへのリンクが作成されます。
-
-
-.. rst:role:: token
-
-   .. The name of a grammar token (used to create links between 
-      :rst:dir:`productionlist` directives).
-
-   文法のトークンの名前です。 :rst:dir:`productionlist` ディレクティブ内の定義との間でリンクが作成されます。
-
-
-.. rst:role:: keyword
-
-   .. The name of a keyword in Python.  This creates a link to a reference label 
-      with that name, if it exists.
-
-   Pythonのキーワード名です。もし存在していれば、この名前を持つ参照ラベルとの間にリンクが作成されます。
-
-
-.. rst:role:: option
-
-   .. A command-line option to an executable program.  The leading hyphen(s) must 
-      be included.  This generates a link to a :rst:dir:`cmdoption` directive, if it 
-      exists.
-
-   実行ファイルのコマンドラインオプションです。前に付くハイフンも含める必要があります。 :rst:dir:`cmdoption` ディレクティブで定義されていれば、リンクを作成します。
-
-
-.. The following role creates a cross-reference to the term in the glossary:
-
-以下のロールは用語集との間にクロスリファレンスを作成します:
-
-.. rst:role:: term
-
-   .. Reference to a term in the glossary.  The glossary is created using the
-      ``glossary`` directive containing a definition list with terms and
-      definitions.  It does not have to be in the same file as the ``term`` markup, 
-      for example the Python docs have one global glossary in the ``glossary.rst`` 
-      file.
-
-   用語集の用語への参照。用語集は ``glossary`` ディレクティブを使用して定義します。用語集と ``term`` マークアップは同じファイルにある必要はありません。例えばPythonのドキュメントは一つの用語集の ``glossary.rst`` というファイルの中にすべての用語の定義が書かれています。
-
-   .. If you use a term that's not explained in a glossary, you'll get a warning 
-      during build.
-
-   もしも、用語集の中で説明されていない用語がある場合には、ビルド時に警告が出力されます。
 
 
 .. Substitutions
-   -------------
+   ~~~~~~~~~~~~~
 
 .. _default-substitutions:
 
 置換
-----
+~~~~
 
 .. The documentation system provides three substitutions that are defined by default. They are set in the build configuration file.
 

File docjp/markup/misc.rst

View file
 
    :フィールド名: フィールドの内容
 
-.. A field list at the very top of a file is parsed by docutils as the "docinfo",
+.. A field list near the very top of a file is parsed by docutils as the "docinfo",
    which is normally used to record the author, date of publication and other
-   metadata.  *In Sphinx*, the docinfo is used as metadata, too, but not displayed
-   in the output.
+   metadata.  *In Sphinx*, a field list preceding any other markup is moved from
+   the docinfo to the Sphinx environment as document metadata and is not displayed
+   in the output; a field list appearing after the document title will be part of
+   the docinfo as normal and will be displayed in the output.
 
-docutilsは、ファイルの先頭のフィールドリストを "docinfo" としてパースします。これは通常のドキュメントでは著者名や、公開日などのメタデータを記録するのに使用されます。 **Sphinxでは**, docinfoはメタデータとして使用されますが、出力はされません。
+docutilsは、ファイルの先頭付近のフィールドリストを "docinfo" としてパースします。これは通常のドキュメントでは著者名や、公開日などのメタデータを記録するのに使用されます。 **Sphinxでは**, docinfoはメタデータとして使用されますが、出力はされません。フィールドリストは、ドキュメントのタイトルの後に、いつものように表示されます。
 
 .. At the moment, these metadata fields are recognized:
 
    :rst:dir:`codeauthor` ディレクティブは、 :rst:dir:`sectionauthor` の名前と同じく、説明しているコードの作者名について、複数人書くことができます。 :confval:`show_authors` 設定値をTrueにしないかぎり、出力はされません。
 
 
+インデックス生成のためのマークアップ
+------------------------------------
+
+.. Sphinx automatically creates index entries from all object description (like 
+   functions, classes or attributes) like discussed :ref:`domains`.
+
+Sphinxはすべてのオブジェクトの説明(関数、クラス、属性)から、自動的にインデックスのエントリーを作成します。オブジェクトの説明に関しては、 :ref:`domains` で詳しく説明しています。
+
+.. However, there is also an explicit directive available, to make the index more 
+   comprehensive and enable index entries in documents where information is not 
+   mainly contained in information units, such as the language reference.
+
+しかし、これ以外に明示的に指定するディレクティブもあります。これを使用することで、言語のリファレンスのように、メインの情報のユニットが存在しない情報をドキュメントの中に書いてインデックスのエントリーを作ることができるようになります。より包括的なインデックスを作成することができるようになります。
+
+.. 
+   .. rst:directive:: .. index:: <entries>
+
+.. rst:directive:: .. index:: <エントリー>
+
+   .. This directive contains one or more index entries.  Each entry consists of a 
+      type and a value, separated by a colon.
+
+   このディレクティブは一つ以上のインデックスのエントリーを含みます。それぞれのエントリーはコロン(:)で区切られた、タイプ、値を含みます。
+
+   .. For example:
+
+      .. index
+         single: 実行; コンテキスト
+         module: __main__
+         module: sys
+         triple: モジュール; 検索; パス
+
+      The execution context
+      ---------------------
+
+      ...
+
+   サンプル::
+
+      .. index::
+         single: execution; context
+         module: __main__
+         module: sys
+         triple: module; search; path
+
+      実行時のコンテキスト
+      ---------------------
+
+      ...
+
+   .. This directive contains five entries, which will be converted to entries in 
+      the generated index which link to the exact location of the index statement 
+      (or, in case of offline media, the corresponding page number).
+
+   このディレクティブは5つのエントリーを含んでいます。これらは生成されたインデックスのエントリーに変換され、index文の正確な位置へのリンクが張られることになります。オフラインのメディアに出力される場合には、リンクの代わりに対応するページ番号が出力されます。
+
+   .. Since index directives generate cross-reference targets at their location in 
+      the source, it makes sense to put them *before* the thing they refer to -- 
+      e.g. a heading, as in the example above.
+
+   indexディレクティブはそのソースの位置のターゲットとのクロスリファレンスを生成するため、それらが参照するものの *前の位置* に置くことが大切になります。上記のサンプルコードの例では、リンクを張りたい見出しの前に配置されています。
+
+   .. The possible entry types are:
+
+   設定可能なエントリーのタイプは以下の通りです:
+
+   .. single
+      Creates a single index entry.  Can be made a subentry by separating the
+      subentry text with a semicolon (this notation is also used below to 
+      describe what entries are created).
+
+   single
+      単体のインデックスのエントリーを作成します。 サブエントリーのテキストとの間をセミコロンで区切ることにより、サブエントリーをサブエントリーを作ることもできます。この記法はどのエントリーが作成されたのか、という説明のところで詳しく説明します。
+
+   .. pair
+      ``pair: loop; statement`` is a shortcut that creates two index entries, 
+      namely ``loop; statement`` and ``statement; loop``.
+
+   pair
+      ``pair: loop; statement`` はインデックスエントリーを2つ作成します。
+      ``loop; statement`` と ``statement; loop`` の2つのエントリーが作成されます。
+
+   .. triple
+      Likewise, ``triple: module; search; path`` is a shortcut that creates 
+      three index entries, which are ``module; search path``, ``search; path, 
+      module`` and ``path; module search``.
+
+   triple
+      pairと似ていますが ``triple: module; search; path`` は3つのエントリーを作成します。 ``module; search path``, ``search; path, module``, ``path; module search`` が作成されます。
+
+   .. see
+      ``see: entry; other`` creates an index entry that refers from ``entry`` to
+      ``other``.
+
+   see
+      ``see: entry; other`` という項目があると、``entry`` から ``other`` を参照するインデックスエントリーが作成されます。
+
+   .. seealso
+      Like ``see``, but inserts "see also" instead of "see".
+
+   seealso
+      ``see`` と似ていますが、 "see" の代わりに、 "see also" を挿入します。
+
+   .. module, keyword, operator, object, exception, statement, builtin
+      These all create two index entries.  For example, ``module: hashlib``
+      creates the entries ``module; hashlib`` and ``hashlib; module``.  (These
+      are Python-specific and therefore deprecated.)
+
+   module, keyword, operator, object, exception, statement, builtin
+      これらはすべて、2つのエントリーを作成します。例えば、 ``module: hashlib`` という項目があると、 ``module; hashlib`` と ``hashlib; module`` の2つのエントリーが作成されます。(これらはPython固有で、deperecatedになっています。)
+
+   .. You can mark up "main" index entries by prefixing them with an exclamation
+      mark.  The references to "main" entries are emphasized in the generated
+      index.  For example, if two pages contain :
+
+   もしエクスクラメーションマーク(!)を前に付けると、主要なインデックスエントリーである、ということを表現することができます。主要なインデックスは、生成されたインデックスの中で強調されます。例えば、2つのページが次のようなディレクティブを持っていたとします::
+
+      .. index:: Python
+
+   .. and one page contains :
+
+   そして、次の内容を含むページがあったとします::
+
+      .. index:: ! Python
+
+   .. then the backlink to the latter page is emphasized among the three backlinks.
+
+   この場合、最後のページへのバックリンクが3つの中では強調されて表示されます。
+
+   .. For index directives containing only "single" entries, there is a shorthand notation:
+
+   "single"のエントリーだけが含まれるindexディレクティブの場合、以下のように短縮記法で簡単に作成することもできます::
+
+      .. index:: BNF, grammar, syntax, notation
+
+   .. This creates four index entries.
+
+   これは4つのインデックスのエントリーが作成されます。
+
+   .. 
+      versionchanged:: 1.1
+      Added ``see`` and ``seealso`` types, as well as marking main entries.
+
+   .. versionchanged:: 1.1
+      ``see`` と ``seealso`` と、メインエントリーのマークが追加されました。
+
+.. rst:role:: index
+
+   .. While the :rst:dir:`index` directive is a block-level markup and links to the
+      beginning of the next paragraph, there is also a corresponding role that sets
+      the link target directly where it is used.
+
+   :rst:dir:`index` ディレクティブは、ブロックレベルのマークアップで、次のパラグラフの先頭に対するリンクを生成します。これとは別に、直接リンクターゲットに設定するロールもあります。
+
+   .. The content of the role can be a simple phrase, which is then kept in the
+      text and used as an index entry.  It can also be a combination of text and
+      index entry, styled like with explicit targets of cross-references.  In that
+      case, the "target" part can be a full entry as described for the directive
+      above.  For example:
+
+      This is a normal reST :index:`paragraph` that contains several
+      :index:`index entries <pair: index; entry>`.
+
+   ロールのコンテンツは、文章の中にあるシンプルなフレーズで、そのままインデックスのエントリーとして使用されます。テキストと入力エントリーの組み合わせになっていて、明示的なクロスリファレンスのターゲットになります。この場合、ターゲットの部分は上記で説明したディレクティブの機能をフルに使うことができます::
+
+      これは、いくつかの :index:`インデックスエントリー <pair: index; entry>` を含む通常のreSTの :index`段落` です。
+
+
+   .. versionadded:: 1.1
+
+
 .. _tags:
 
 タグを使用したインクルード
 
    Undefined tags are false, defined tags (via the ``-t`` command-line option or
    within :file:`conf.py`) are true.  Boolean expressions, also using
-   parentheses (like ``html and (latex or draft)`` are supported.
+   parentheses (like ``html and (latex or draft)``) are supported.
 
    The format of the current builder (``html``, ``latex`` or ``text``) is always
    set as a tag.
 
 .. warning::
 
-   リテラルブロックを含むテーブルには ``tabulary`` は適用できません。このような場合には、LaTeX標準の ``tabular`` 環境が使用されます。また、 ``p{width}`` を設定しないと、同様な環境は使用することはできません。デフォルトでは、というのは、Sphinxはそのようなテーブルのためには、そのようなカラムを生成します。 :rst:dir:`tabularcolums` ディレクティブを使用することで、テーブルに対して細かい制御ができるようになります。
+   .. Tables that contain list-like elements such as object descriptions,
+      blockquotes or any kind of lists cannot be set out of the box with
+      ``tabulary``.  They are therefore set with the standard LaTeX ``tabular``
+      environment if you don't give a ``tabularcolumns`` directive.  If you do, the
+      table will be set with ``tabulary``, but you must use the ``p{width}``
+      construct for the columns that contain these elements.
 
-.. Tables that contain literal blocks cannot be set with ``tabulary``.  They are
-   therefore set with the standard LaTeX ``tabular`` environment.  Also, the
-   verbatim environment used for literal blocks only works in ``p{width}``
-   columns, which means that by default, Sphinx generates such column specs for
-   such tables.  Use the :rst:dir:`tabularcolumns` directive to get finer control
-   over such tables.
+   オブジェクトの説明などのリストのような要素や、ブロッククオート、リストなどを含むテーブルは、 ``tabulary`` 環境では、箱に並べることはできません。``tabularcolumns`` ディレクティブを与えていない場合は、LaTeX標準の ``tabular`` 環境が使用されます。このような要素を含めようとしている場合、テーブルに ``tabulary`` がセットされますが、これらの要素ほ含むカラムには、 ``p{width}`` コンストラクタを使うようにしてください。
 
+   .. Literal blocks do not work with ``tabulary`` at all, so tables containing a
+      literal block are always set with ``tabular``.  Also, the verbatim
+      environment used for literal blocks only works in ``p{width}`` columns, which
+      means that by default, Sphinx generates such column specs for such tables.
+      Use the :rst:dir:`tabularcolumns` directive to get finer control over such
+      tables.
+
+   リテラルブロックは ``tabulary`` と一緒にしても、まったく動作しませんが、リテラルブロックを含むテーブルは ``tabular`` をセットします。また、 ``p{width}`` を設定しないと、同様な環境は使用することはできません。デフォルトでは、というのは、Sphinxはそのようなテーブルのためには、そのようなカラムを生成します。 :rst:dir:`tabularcolums` ディレクティブを使用することで、テーブルに対して細かい制御ができるようになります。
+
+
+
+
+
+

File docjp/markup/para.rst

View file
    noteよりも重要な情報があり、APIを使用する際に、気をつけなければならない警告情報をユーザに伝えるために使用するのに適しています。このディレクティブの中身には、適切に句読点が付いた、完全な文章を書くべきです。 :rst:dir:`note` との違いで言えば、セキュリティに関する情報は :rst:dir:`note` よりもこのディレクティブを使用する方が良いでしょう。
 
 
-.. .. rst:directive:: .. versionadded:: version
-
-..   This directive documents the version of the project which added the described feature to the library or C API. When this applies to an entire module, it should be placed at the top of the module section before any prose.
-
-..   The first argument must be given and is the version in question; you can add a second argument consisting of a *brief* explanation of the change.
-
-
-..   Example
-
-..      .. versionadded:: 2.5
-..         The `spam` parameter.
-
-..   Note that there must be no blank line between the directive head and the explanation; this is to make these blocks visually continuous in the markup.
+.. 
+   .. rst:directive:: .. versionadded:: version
 
 .. rst:directive:: .. versionadded:: バージョン
 
+   .. This directive documents the version of the project which added the 
+      described feature to the library or C API. When this applies to an 
+      entire module, it should be placed at the top of the module section 
+      before any prose.
+
    このディレクティブは説明している機能がライブラリ、もしくはC APIに追加された時のプロジェクトのバージョンについて記述するのに使用します。このディレクティブがモジュール全体に対して適用する場合には、モジュールセクションの先頭の、文章が始まる前の位置に置くべきです。
 
+   .. The first argument must be given and is the version in question; you 
+      can add a second argument consisting of a *brief* explanation of the change.
+
    最初の引数は必須で、バージョン番号を書く必要があります。2番目の引数も追加することができ、変化に対する *短い* 説明を書くことができます。
 
-..   Example
+   .. Example
+      .. versionadded:: 2.5
+         The *spam* parameter.
 
    サンプル::
 
       .. versionadded:: 2.5
-         `spam` パラメータ
+         *spam* パラメータ
+
+   .. Note that there must be no blank line between the directive head and 
+      the explanation; this is to make these blocks visually continuous in 
+      the markup.
 
    ディレクティブヘッドと説明の間には空行を入れてはいけません。マークアップの中では見た目上つながっているようにしなければなりません。
 
 
 .. rst:directive:: .. versionchanged:: バージョン
 
-   .. Similar to :rst:dir:`versionadded`, but describes when and what changed in the named 
-      feature in some way (new parameters, changed side effects, etc.).
+   .. Similar to :rst:dir:`versionadded`, but describes when and what changed in 
+      the named feature in some way (new parameters, changed side effects, etc.).
 
    :rst:dir:`versionadded` と似ていますが、現在説明している機能がいつどのように変化したのか(新しい引数、副作用の変更など)を説明するのに使用します。
 
+
+.. 
+   rst:directive:: .. deprecated:: version
+
+.. rst:directive:: .. deprecated:: バージョン
+
+   .. Similar to :rst:dir:`versionchanged`, but describes when the feature was
+      deprecated.  An explanation can also be given, for example to inform the
+      reader what should be used instead.  Example::
+
+      .. deprecated:: 3.1
+         Use :func:`spam` instead.
+
+   
+   :rst:dir:`versionchanged` と似ていますが、このディレクティブは、この機能がすでに古くて非推奨になったことを示しています。代替として、今後何を使っていくべきなのかといった説明文を付けることができます::
+
+      .. deprecated:: 3.1
+         今後は代わりに :func:`spam` を使用すること
+
 --------------
 
 .. rst:directive:: .. seealso::
 
       .. centered:: ラインセンス契約
 
+   .. deprecated:: 1.1
+
+      この表現のみのディレクティブはレガシーなディレクティブになりますので、今後は、 :rst:dir:`rst-class` ディレクティブを代わりに使い、適切なスタイルを与えてください。
+
+      .. This presentation-only directive is a legacy from older versions.  Use a
+         :rst:dir:`rst-class` directive instead and add an appropriate style.
 
 .. rst:directive:: hlist
 
 
 .. Index-generating markup
 
-インデックス生成のためのマークアップ
-------------------------------------
-
-.. Sphinx automatically creates index entries from all object description (like 
-   functions, classes or attributes) like discussed :ref:`domains`.
-
-Sphinxはすべてのオブジェクトの説明(関数、クラス、属性)から、自動的にインデックスのエントリーを作成します。オブジェクトの説明に関しては、 :ref:`domains` で詳しく説明しています。
-
-.. However, there is also an explicit directive available, to make the index more 
-   comprehensive and enable index entries in documents where information is not 
-   mainly contained in information units, such as the language reference.
-
-しかし、これ以外に明示的に指定するディレクティブもあります。これを使用することで、言語のリファレンスのように、メインの情報のユニットが存在しない情報をドキュメントの中に書いてインデックスのエントリーを作ることができるようになります。より包括的なインデックスを作成することができるようになります。
-
-.. 
-   .. rst:directive:: .. index:: <entries>
-
-.. rst:directive:: .. index:: <エントリー>
-
-   .. This directive contains one or more index entries.  Each entry consists of a 
-      type and a value, separated by a colon.
-
-   このディレクティブは一つ以上のインデックスのエントリーを含みます。それぞれのエントリーはコロン(:)で区切られた、タイプ、値を含みます。
-
-   .. For example:
-
-      .. index
-         single: 実行; コンテキスト
-         module: __main__
-         module: sys
-         triple: モジュール; 検索; パス
-
-      The execution context
-      ---------------------
-
-      ...
-
-   サンプル::
-
-      .. index::
-         single: execution; context
-         module: __main__
-         module: sys
-         triple: module; search; path
-
-      実行時のコンテキスト
-      ---------------------
-
-      ...
-
-   .. This directive contains five entries, which will be converted to entries in 
-      the generated index which link to the exact location of the index statement 
-      (or, in case of offline media, the corresponding page number).
-
-   このディレクティブは5つのエントリーを含んでいます。これらは生成されたインデックスのエントリーに変換され、index文の正確な位置へのリンクが張られることになります。オフラインのメディアに出力される場合には、リンクの代わりに対応するページ番号が出力されます。
-
-   .. Since index directives generate cross-reference targets at their location in 
-      the source, it makes sense to put them *before* the thing they refer to -- 
-      e.g. a heading, as in the example above.
-
-   indexディレクティブはそのソースの位置のターゲットとのクロスリファレンスを生成するため、それらが参照するものの *前の位置* に置くことが大切になります。上記のサンプルコードの例では、リンクを張りたい見出しの前に配置されています。
-
-   .. The possible entry types are:
-
-   設定可能なエントリーのタイプは以下の通りです:
-
-   .. single
-      Creates a single index entry.  Can be made a subentry by separating the
-      subentry text with a semicolon (this notation is also used below to 
-      describe what entries are created).
-
-   single
-      単体のインデックスのエントリーを作成します。 サブエントリーのテキストとの間をセミコロンで区切ることにより、サブエントリーをサブエントリーを作ることもできます。この記法はどのエントリーが作成されたのか、という説明のところで詳しく説明します。
-
-   .. pair
-      ``pair: loop; statement`` is a shortcut that creates two index entries, 
-      namely ``loop; statement`` and ``statement; loop``.
-
-   pair
-      ``pair: loop; statement`` はインデックスエントリーを2つ作成します。
-      ``loop; statement`` と ``statement; loop`` の2つのエントリーが作成されます。
-
-   .. triple
-      Likewise, ``triple: module; search; path`` is a shortcut that creates 
-      three index entries, which are ``module; search path``, ``search; path, 
-      module`` and ``path; module search``.
-
-   triple
-      pairと似ていますが ``triple: module; search; path`` は3つのエントリーを作成します。 ``module; search path``, ``search; path, module``, ``path; module search`` が作成されます。
-
-   .. module, keyword, operator, object, exception, statement, builtin
-      These all create two index entries.  For example, ``module: hashlib``
-      creates the entries ``module; hashlib`` and ``hashlib; module``.  (These
-      are Python-specific and therefore deprecated.)
-
-   module, keyword, operator, object, exception, statement, builtin
-      これらはすべて、2つのエントリーを作成します。例えば、 ``module: hashlib`` という項目があると、 ``module; hashlib`` と ``hashlib; module`` の2つのエントリーが作成されます。(これらはPython固有で、deperecatedになっています。)
-
-   .. For index directives containing only "single" entries, there is a shorthand notation:
-
-   "single"のエントリーだけが含まれるindexディレクティブの場合、以下のように短縮記法で簡単に作成することもできます::
-
-      .. index:: BNF, grammar, syntax, notation
-
-   .. This creates four index entries.
-
-   これは4つのインデックスのエントリーが作成されます。
-
 
 .. Glossary
 
       definitions.  The definitions will then be referencable with the :rst:role:`term` 
       role.  
 
+   .. This directive must contain a reST definition-list-like markup with terms and
+      definitions.  The definitions will then be referencable with the
+      :rst:role:`term` role.  Example:
+
+   どのディレクティブは、用語と定義が一緒になった、マークアップのようなreST定義リストを含みます。定義は :rst:role:`term` というロールを利用することで参照が可能になります:
+
    .. .. Example:
 
-   .. .. glossary::
+      .. glossary::
 
-   ..    environment
-         A structure where information about all documents under the root is 
-         saved, and used for cross-referencing.  The environment is pickled 
-         after the parsing stage, so that successive runs only need to read 
-         and parse new and changed documents.
+         environment
+            A structure where information about all documents under the root is 
+            saved, and used for cross-referencing.  The environment is pickled 
+            after the parsing stage, so that successive runs only need to read 
+            and parse new and changed documents.
 
-   ..    source directory
-         The directory which, including its subdirectories, contains all 
-         source files for one Sphinx project.
-
-   このディレクティブは用語と定義がリストになった、reST定義リストを含みます。定義は :rst:role:`term` というロールを利用することで参照が可能になります。以下にサンプルを示します。
+         source directory
+            The directory which, including its subdirectories, contains all 
+            source files for one Sphinx project.
 
    サンプル::
 
             このディレクトリ直下だけではなく、サブディレクトリを使用してソースファイルを
             分類して入れておくことも可能です。
 
-   .. 
-      .. versionadded:: 0.6
-         You can now give the glossary directive a ``:sorted:`` flag that will
-         automatically sort the entries alphabetically.
+   .. In contrast to regular definition lists, *multiple* terms per entry are
+      allowed, and inline markup is allowed in terms.  You can link to all of the
+      terms.  For example:
+
+      .. glossary::
+
+         term 1
+         term 2
+            Definition of both terms.
+
+      (When the glossary is sorted, the first term determines the sort order.)
+
+   通常の定義リストとは異なり、一つのエントリーに対して、複数の用語を定義することができます。それぞれの用語に対してインラインマークアップを使うことができます。また、すべての用語への参照も可能です::
+
+      .. glossary::
+
+         用語1
+         用語2
+            両方の単語の定義
 
    .. versionadded:: 0.6
       glossaryディレクティブに ``:sorted:`` というフラッグを与えることができるようになりました。これを指定すると、自動的にエントリーをアルファベット順に並べることができます。
 
+      .. You can now give the glossary directive a ``:sorted:`` flag that will
+         automatically sort the entries alphabetically.
+
+   .. versionchanged:: 1.1
+ 
+      複数用語の定義と、用語に対するインラインマークアップが可能になりました。
+      
+      .. Now supports multiple terms and inline markup in terms.
+
+
 
 .. Grammar production displays
 

File docjp/markup/toctree.rst

View file
    * ここで指定されたファイル群(intro, stringsなど)の項目も取り込んで目次を作成しています。最大の深さは2に指定されています。つまり、関連するドキュメントからトップの1階層分の項目を取得してきて目次に挿入しています。指定されたファイルに ``toctree`` ディレクティブがあればそれも利用されます。
    * Sphinxはこのディレクティブから、関連するドキュメントが ``intro``, ``strings`` という順番を持っていて、これらのファイルがライブラリインデックスの子供であるという情報を収集します。これらの情報を使って、"next chapter", "previous chapter", "parent chapter"というリンクが作成されます。
 
+   .. **Entries**
+
+   **エントリー**
+
    .. Document titles in the :rst:dir:`toctree` will be automatically read from the
       title of the referenced document. If that isn't what you want, you can
       specify an explicit title and target using a similar syntax to reST
 
    また、ドキュメント名の代わりに、HTTPのURLを指定することで外部へのリンクを追加することもできます。
 
+   .. 
+      **Section numbering**
+
+   **セクションのナンバリング**
+
    If you want to have section numbers even in HTML output, give the toctree a
-   ``numbered`` flag option.  For example:
+   ``numbered`` option.  For example:
 
-   もし、セクション番号をHTML出力に追加したい場合には、 ``numbered`` フラグオプションをtoctreeに追加します::
+   もし、セクション番号をHTML出力に追加したい場合には、 ``numbered`` オプションをtoctreeに追加します::
 
       .. toctree::
          :numbered:
 
    ナンバリングは ``foo`` の見出しから開始されます。サブの目次のツリーに対しても自動的にナンバリングされています。サブの文章のtoctreeには ``numbered`` フラグが設定されていなくても自動的に処理が行われます。  
 
+   .. Numbering up to a specific depth is also possible, by giving the depth as a
+      numeric argument to ``numbered``.
+
+   特定の深さまでのナンバリングだけを行うこともできます。 ``numbered`` 引数に対して、数値で深さを指定してください。
+
+   .. **Additional options**
+
+   **追加のオプション**
+
    .. If you want only the titles of documents in the tree to show up, not other
       headings of the same level, you can use the ``titlesonly`` option:
 
 
    "マスタードキュメント" (:confval:`master_doc` で指定します)はTOCツリー階層の"ルート"のドキュメントになります。これはドキュメントのメインページとして使うことができます。あるいは、``maxdepth``オプションを指定しない、完全な目次を作成することもできます。
 
-   .. .. versionchanged:: 0.3
-         Added "globbing" option.
-
    .. versionchanged:: 0.3
       "glob"オプションが追加されました
 
-   .. .. versionchanged:: 0.6
-         Added "numbered" and "hidden" options as well as external links and
-         support for "self" references.
+      .. Added "globbing" option.
 
    .. versionchanged:: 0.6
       "numbered"と"hidden"オプション、外部リンクのサポート、"self"参照が追加されました。
 
-   .. .. versionchanged:: 1.0
-         Added "titlesonly" option.
+      .. Added "numbered" and "hidden" options as well as external links and
+         support for "self" references.
 
    .. versionchanged:: 1.0
       "titlesonly" オプションが追加されました。
+      
+      .. Added "titlesonly" option.
+
+   .. versionchanged:: 1.1
+      "numbered" に数値の引数が追加されました。
+
+      .. Added numeric argument to "numbered".
 
 
 .. Special names
      :ref:`object descriptions <basic-domain-markup>`, and from :rst:dir:`index`
      directives.
 
-     The module index contains one entry per :rst:dir:`module` directive.
+     The Python module index contains one entry per :rst:dir:`py:module` directive.
 
      The search page contains a form that uses the generated JSON search index and
      JavaScript to full-text search the generated documents for search words; it

File docjp/rest.rst

View file
 
    .. function:: foo(x)
                  foo(y, z)
-      :bar: no
+      :module: some.module.name
 
       Return a line of text input from the user.
 
 
    .. function:: foo(x)
                  foo(y, z)
-      :bar: no
+      :module: some.module.name
 
       ユーザから入力されたテキストのうち、1行を返します。
 
 .. ``function`` is the directive name.  It is given two arguments here, the
    remainder of the first line and the second line, as well as one option 
-   ``bar`` (as you can see, options are given in the lines immediately 
-   following the arguments and indicated by the colons).
+   ``module`` (as you can see, options are given in the lines immediately following 
+   the arguments and indicated by the colons). Options must be indented to the
+   same level as the directive content.
 
-``function`` がディレクティブの名前です。ここでは二つの引数が与えられています。1行目の残りの部分と、2行目が引数です。そして1つのオプション ``bar`` も同様に設定されています。見ての通り、オプションは引数のある行のすぐ次の行に書かれていています。そして、目印としてコロンが付いています。
+
+``function`` がディレクティブの名前です。ここでは二つの引数が与えられています。1行目の残りの部分と、2行目が引数です。そして1つのオプション ``module`` も同様に設定されています。見ての通り、オプションは引数のある行のすぐ次の行に書かれていています。そして、目印としてコロンが付いています。オプションは、ディレクティブのコンテンツと同じインデントの高さにします。
 
 .. The directive content follows after a blank line and is indented relative 
    to the directive start.

File docjp/templating.rst

View file
 * 読者が使用したいテンプレートエンジンを呼び出すような :class:`~sphinx.application.TemplateBridge` クラスのサブクラスを書いて、それが呼ばれるように :confval:`template_bridge` 設定値に設定します。
 
 .. * You can :ref:`write a custom builder <writing-builders>` that derives from
-     :class:`~sphinx.builders.StandaloneHTMLBuilder` and calls your template engine
-     of choice.
+     :class:`~sphinx.builders.html.StandaloneHTMLBuilder` and calls your template 
+     engine of choice.
 
-* :class:`~sphinx.builders.StandaloneHTMLBuilder` を継承して :ref:`カスタムビルダーを書いて <writing-builders>` 好きなテンプレートエンジンを呼ぶようにします。
+* :class:`~sphinx.builders.html.StandaloneHTMLBuilder` を継承して :ref:`カスタムビルダーを書いて <writing-builders>` 好きなテンプレートエンジンを呼ぶようにします。
 
 .. * You can use the :class:`~sphinx.builders.PickleHTMLBuilder` that produces
      pickle files with the page contents, and postprocess them using a custom tool,
 
 .. data:: file_suffix
 
-   .. The value of the builder's :attr:`out_suffix` attribute, i.e. the file name
-      extension that the output files will get.  For a standard HTML builder, this
-      is usually ``.html``.
+   .. The value of the builder's :attr:`~.SerializingHTMLBuilder.out_suffix` 
+      attribute, i.e. the file name extension that the output files will get.  For 
+      a standard HTML builder, this is usually ``.html``.
 
-   ビルダーの :attr:`out_suffix` アトリビュートの値です。出力ファイル名に付く拡張子などです。標準のHTMLビルダーの場合には、通常は ``.html`` になります。
+   ビルダーの :attr:`~.SerializingHTMLBuilder.out_suffix` アトリビュートの値です。出力ファイル名に付く拡張子などです。標準のHTMLビルダーの場合には、通常は ``.html`` になります。
 
 
 .. data:: has_source

File docjp/theming.rst

View file
 |                    |                    |
 | *traditional*      | *nature*           |
 +--------------------+--------------------+
-| |haiku|            |                    |
+| |haiku|            | |pyramid|          |
 |                    |                    |
-| *haiku*            |                    |
+| *haiku*            | *pyramid*          |
 +--------------------+--------------------+
 
 .. |default|     image:: themes/default.png
 .. |traditional| image:: themes/traditional.png
 .. |nature|      image:: themes/nature.png
 .. |haiku|       image:: themes/haiku.png
+.. |pyramid|     image:: themes/pyramid.png
 
 .. Sphinx comes with a selection of themes to choose from.
 
      - **footerbgcolor** (CSS color): Background color for the footer line.
      - **footertextcolor** (CSS color): Text color for the footer line.
      - **sidebarbgcolor** (CSS color): Background color for the sidebar.
+     - **sidebarbtncolor** (CSS color): Background color for the sidebar collapse
+       button (used when *collapsiblesidebar* is true).
      - **sidebartextcolor** (CSS color): Text color for the sidebar.
      - **sidebarlinkcolor** (CSS color): Link color for the sidebar.
      - **relbarbgcolor** (CSS color): Background color for the relation bar.
   - **footerbgcolor** (CSSカラー): フッターの背景色です。
   - **footertextcolor** (CSSカラー): フッターのテキストカラーです。
   - **sidebarbgcolor** (CSSカラー): サイドバーの背景色です。
+  - **sidebarbtncolor** (CSSカラー): サイドバーの展開ボタンの背景色です(*collapsiblesidebar* がtrueの時)。
   - **sidebartextcolor** (CSSカラー): サイドバーのテキストカラーです。
   - **sidebarlinkcolor** (CSSカラー): サイドバーのリンクの色です。
   - **relbarbgcolor** (CSSカラー): リレーションバーの背景色です。
      currently no options beyond *nosidebar*.
 
 .. * **scrolls** -- A more lightweight theme, based on `the Jinja documentation
-     <http://jinja.pocoo.org/2/documentation/>`_.  The following color options are
+     <http://jinja.pocoo.org/>`_.  The following color options are
      available:
 
-* **scrolls** -- `テンプレートエンジンのJinjaのドキュメント <http://jinja.pocoo.org/2/documentation/>`_ で使用されている、軽量なテーマです。次のような色に関するオプションがあります。
+* **scrolls** -- `テンプレートエンジンのJinjaのドキュメント <http://jinja.pocoo.org/>`_ で使用されている、軽量なテーマです。次のような色に関するオプションがあります。
 
   - **headerbordercolor**
   - **subheadlinecolor**
      - **textcolor**, **headingcolor**, **linkcolor**, **visitedlinkcolor**,
        **hoverlinkcolor** (CSS colors): Colors for various body elements.
 
+.. * **pyramid** -- A theme from the Pyramid web framework project, designed by
+     Blaise Laflamme.  THere are currently no options beyond *nosidebar*.
+
+* **pyramid** -- Blaise Laflammeがデザインした、Pyramidウェブフレームワークプロジェクトのテーマです。 *nosidebar* 以外のオプションはありません。
+
+
 * **haiku** -- `Haiku OS user guide <http://www.haiku-os.org/docs/userguide/en/contents.html>`_ にインスパイアされた、サイドバーのないテーマです。次のようなオプションが提供されています:
 
   - **full_logo** (True/False デフォルトはFalse): もしTrueの場合は、ヘッダーには :confval:`html_logo` だけが表示されます。大きなロゴを使用するときに設定して下さい。Falseが設定されると、ロゴはフローティングで右寄せに表示され(あれば)、ドキュメントタイトルがヘッダに表示されます。
 .. * A :file:`theme.conf` file, see below.
    * HTML templates, if needed.
    * A ``static/`` directory containing any static files that will be copied to the
-     output statid directory on build.  These can be images, styles, script files.
+     output static directory on build.  These can be images, styles, script files.
 
 * :file:`theme.conf` ファイル
 * HTMLテンプレート(必要に応じて)

File docjp/web/api.rst

View file
 
 .. currentmodule:: sphinx.websupport
 
-The WebSupport Class
-====================
+.. The WebSupport Class
+   ====================
+
+WebSupportクラス
+================
 
 .. class:: WebSupport
 
-   The main API class for the web support package.  All interactions with the
-   web support package should occur through this class.
+   .. The main API class for the web support package.  All interactions with the
+      web support package should occur through this class.
 
-   The class takes the following keyword arguments:
+   ウェブサポートパッケージのメインとなるAPIクラスです。ウェブサポートパッケージに対して行われる、すべてのインタラクションは、このクラスを通じて行われます。
+
+   .. The class takes the following keyword arguments:
+
+   このクラスは、次のようなキーワード引数を取ります:
 
    srcdir
-      The directory containing reStructuredText source files.
+      reStructuredTextのソースファイルを含むディレクトリです。
+
+      .. The directory containing reStructuredText source files.
 
    builddir
-      The directory that build data and static files should be placed in.  This
-      should be used when creating a :class:`WebSupport` object that will be
-      used to build data.
+      ビルド済みのデータや、静的ファイルを置くべきディレクトリです。これはデータをビルドする :class:`WebSupport` オブジェクトを作る時に使用されます。
+
+      .. The directory that build data and static files should be placed in.  This
+         should be used when creating a :class:`WebSupport` object that will be
+         used to build data.
 
    datadir
-      The directory that the web support data is in.  This should be used when
-      creating a :class:`WebSupport` object that will be used to retrieve data.
+      ウェブサポートのデータが置かれるディレクトリです。このデータを読み込む :class:`WebSupport` オブジェクトが作成されるときに使用されます。
+
+      .. The directory that the web support data is in.  This should be used when
+         creating a :class:`WebSupport` object that will be used to retrieve data.
+
 
    search
-       This may contain either a string (e.g. 'xapian') referencing a built-in
-       search adapter to use, or an instance of a subclass of
-       :class:`~.search.BaseSearch`.
+      これは組み込みの検索アダプタを参照するための文字列(例: 'xapian')か、 :class:`~.search.BaseSearch` クラスのサブクラスのインスタンスを指定します。
+
+      .. This may contain either a string (e.g. 'xapian') referencing a built-in
+          search adapter to use, or an instance of a subclass of
+          :class:`~.search.BaseSearch`.
 
    storage
-       This may contain either a string representing a database uri, or an
-       instance of a subclass of :class:`~.storage.StorageBackend`.  If this is
-       not provided, a new sqlite database will be created.
+       これはデータベースのURIを表す文字列、もしくは :class:`~.storage.StorageBackend` のサブクラスのインスタンスを指定します。もしどちらも指定されなかった場合には、新しいsqliteデータベースが作られます。
+
+       .. This may contain either a string representing a database uri, or an
+          instance of a subclass of :class:`~.storage.StorageBackend`.  If this is
+          not provided, a new sqlite database will be created.
 
    moderation_callback
-       A callable to be called when a new comment is added that is not
-       displayed.  It must accept one argument: a dictionary representing the
-       comment that was added.
+      非表示の新しいコメントが追加されたときに呼び出されるコールバックです。この関数には、追加されたコメントを表す引数が1つ渡されます。
+
+      .. A callable to be called when a new comment is added that is not
+         displayed.  It must accept one argument: a dictionary representing the
+         comment that was added.
 
    staticdir
-       If static files are served from a location besides ``'/static'``, this
-       should be a string with the name of that location
-       (e.g. ``'/static_files'``).
+      静的ファイルが提供される場所が、 ``'/tatic'`` 以外の場合には、その場所の名前を表す文字列(例: ``'/static_files'``)を指定します。
+
+      .. If static files are served from a location besides ``'/static'``, this
+         should be a string with the name of that location
+         (e.g. ``'/static_files'``).
 
    docroot
-       If the documentation is not served from the base path of a URL, this
-       should be a string specifying that path (e.g. ``'docs'``).
+      ドキュメントがURLのベースパスから送信されない場合には、そのパスを表す文字(例: ``'docs'``)を指定します。
 
+      .. If the documentation is not served from the base path of a URL, this
+         should be a string specifying that path (e.g. ``'docs'``).
 
-Methods
-~~~~~~~
+
+.. Methods
+   ~~~~~~~
+
+メソッド
+~~~~~~~~
 
 .. automethod:: sphinx.websupport.WebSupport.build
 

File docjp/web/quickstart.rst

View file
 .. _websupportquickstart:
 
-Web Support Quick Start
-=======================
+Webサポートクイックスタート
+============================
 
-Building Documentation Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. Web Support Quick Start
+   =======================
 
-To make use of the web support package in your application you'll need to build
-the data it uses.  This data includes pickle files representing documents,
-search indices, and node data that is used to track where comments and other
-things are in a document.  To do this you will need to create an instance of the
-:class:`~.WebSupport` class and call its :meth:`~.WebSupport.build` method::
+.. Building Documentation Data
+   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ドキュメントデータのビルド
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. To make use of the web support package in your application you'll need to build
+   the data it uses.  This data includes pickle files representing documents,
+   search indices, and node data that is used to track where comments and other
+   things are in a document.  To do this you will need to create an instance of the
+   :class:`~.WebSupport` class and call its :meth:`~.WebSupport.build` method::
+
+アプリケーションの中でウェブサポートパッケージを使用する場合は、まずはデータを作る必要があります。データには、pickle化されたドキュメントや検索インデックス、コメントなどがどのドキュメントに付加されたのかを追跡するためのノードデータが含まれます。これを行うためには、 :class:`~.WebSupport` クラスのインスタンスを作り、 :meth:`~.WebSupport.build` メソッドを呼ぶ必要があります::
 
    from sphinx.websupport import WebSupport
 
 
    support.build()
 
-This will read reStructuredText sources from `srcdir` and place the necessary
-data in `builddir`.  The `builddir` will contain two sub-directories: one named
-"data" that contains all the data needed to display documents, search through
-documents, and add comments to documents.  The other directory will be called
-"static" and contains static files that should be served from "/static".
+.. This will read reStructuredText sources from `srcdir` and place the necessary
+   data in `builddir`.  The `builddir` will contain two sub-directories: one named
+   "data" that contains all the data needed to display documents, search through
+   documents, and add comments to documents.  The other directory will be called
+   "static" and contains static files that should be served from "/static".
+
+このコードは、reStructuredTextのソースコードを `srcdir` から読み込み、必要なデータを `builddir` に書き出します。 `builddir` は二つのサブディレクトリを含みます。 :file:`data` には、ドキュメントを表示したり、ドキュメントを検索したり、ドキュメントにコメントを付けるのに必要なデータがすべて含まれます。もう一つの :file:`static` ディレクトリは、 :file:`'/static'` からファイルを配信するための、静的ファイルを含みます。
 
 .. note::
 
-   If you wish to serve static files from a path other than "/static", you can
-   do so by providing the *staticdir* keyword argument when creating the
-   :class:`~.WebSupport` object.
+   .. If you wish to serve static files from a path other than "/static", you can
+      do so by providing the *staticdir* keyword argument when creating the
+      :class:`~.WebSupport` object.
 
+   もし "/static" 以外のパスから静的ファイルの配信をしたい場合には、 :class:`~.WebSupport` オブジェクトを作る時に、 **staticdir** キーワード引数を指定してください。
 
-Integrating Sphinx Documents Into Your Webapp
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Now that the data is built, it's time to do something useful with it.  Start off
-by creating a :class:`~.WebSupport` object for your application::
+.. Integrating Sphinx Documents Into Your Webapp
+   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sphinxドキュメントをウェブアプリケーションに統合
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. Now that the data is built, it's time to do something useful with it.  Start off
+   by creating a :class:`~.WebSupport` object for your application:
+
+データができましたので、次はこれを使う番です。アプリケーションのための :class:`~.WebSupport` オブジェクトを作るところから始めます::
 
    from sphinx.websupport import WebSupport
 
    support = WebSupport(datadir='/path/to/the/data',
                         search='xapian')
 
-You'll only need one of these for each set of documentation you will be working
-with.  You can then call it's :meth:`~.WebSupport.get_document` method to access
-individual documents::
+.. You'll only need one of these for each set of documentation you will be working
+   with.  You can then call it's :meth:`~.WebSupport.get_document` method to access
+   individual documents:
+
+次に、個々のドキュメントに対する処理を作っていきます。 :meth:`~.WebSupport.get_document` メソッドを呼ぶと、個々のドキュメントにアクセスすることができます::
 
    contents = support.get_document('contents')
 
-This will return a dictionary containing the following items:
+このメソッドは、次のキーを持つ辞書を返します:
 
-* **body**: The main body of the document as HTML
-* **sidebar**: The sidebar of the document as HTML
-* **relbar**: A div containing links to related documents
-* **title**: The title of the document
-* **css**: Links to css files used by Sphinx
-* **js**: Javascript containing comment options
+.. This will return a dictionary containing the following items:
 
-This dict can then be used as context for templates.  The goal is to be easy to
-integrate with your existing templating system.  An example using `Jinja2
-<http://jinja.pocoo.org/2/>`_ is:
+.. * **body**: The main body of the document as HTML
+   * **sidebar**: The sidebar of the document as HTML
+   * **relbar**: A div containing links to related documents
+   * **title**: The title of the document
+   * **css**: Links to css files used by Sphinx
+   * **js**: Javascript containing comment options
+
+* **body**: HTML形式のドキュメント本体です。
+* **sidebar**: HTML形式のサイドバーです。
+* **relbar**: このdivは、関連ドキュメントへのリンクを含んでいます。
+* **title**: ドキュメントのタイトルです。
+* **css**: Sphinxが使用するCSSファイルへのリンクです。
+* **js**: コメントオプションを含むJavascriptです。
+
+.. This dict can then be used as context for templates.  The goal is to be easy to
+   integrate with your existing templating system.  An example using `Jinja2
+   <http://jinja.pocoo.org/>`_ is:
+
+この辞書は、テンプレートのコンテキストとして使用することができます。既存のどのテンプレートシステムとも簡単に統合できるようにすることを目標としています。例えば、 `Jinja2 <http://jinja.pocoo.org/>`_ を使用する場合は、以下のようになります。
 
 .. sourcecode:: html+jinja
 
    {%- endblock %}
 
 
-Authentication
---------------
+.. Authentication
+   --------------
 
-To use certain features such as voting, it must be possible to authenticate
-users.  The details of the authentication are left to your application.  Once a
-user has been authenticated you can pass the user's details to certain
-:class:`~.WebSupport` methods using the *username* and *moderator* keyword
-arguments.  The web support package will store the username with comments and
-votes.  The only caveat is that if you allow users to change their username you
-must update the websupport package's data::
+認証
+----
+
+.. To use certain features such as voting, it must be possible to authenticate
+   users.  The details of the authentication are left to your application.  Once a
+   user has been authenticated you can pass the user's details to certain
+   :class:`~.WebSupport` methods using the *username* and *moderator* keyword
+   arguments.  The web support package will store the username with comments and
+   votes.  The only caveat is that if you allow users to change their username you
+   must update the websupport package's data:
+
+投票のような機能を実装する場合、ユーザ認証ができる必要があります。認証をどのように実装するかはアプリケーションに任されています。ユーザが認証されたら、ユーザの情報を :class:`~.WebSupport` のメソッドの *username* と *moderator* キーワード引数に渡すことができます。ウェブサポートパッケージはユーザ名を、コメントや投票と一緒に保存します。注意点を1つあげるとすれば、もしユーザに対して名前の変更を行えるようにするのであれば、ウェブサポートパッケージの内部のユーザ名のデータも更新する必要があります::
 
    support.update_username(old_username, new_username)
 
-*username* should be a unique string which identifies a user, and *moderator*
-should be a boolean representing whether the user has moderation privilieges.
-The default value for *moderator* is *False*.
+.. *username* should be a unique string which identifies a user, and *moderator*
+   should be a boolean representing whether the user has moderation privilieges.
+   The default value for *moderator* is *False*.
 
-An example `Flask <http://flask.pocoo.org/>`_ function that checks whether a
-user is logged in and then retrieves a document is::
+*username* はユーザを特定するためのユニークな文字列でなければなりません。また、 *moderator* はユーザがモデレート権限を持っているかどうかを表すブール型でなければなりません。 *moderator* のデフォルト値は ``False`` です。
+
+.. An example `Flask <http://flask.pocoo.org/>`_ function that checks whether a
+   user is logged in and then retrieves a document is::
+
+例えば、 `Flask <http://flask.pocoo.org/>`_ を使用して、ユーザがログインしているかどうかを確認し、ドキュメントを読めるようにするには、次のようなコードで行えます::
 
    from sphinx.websupport.errors import *
 
            abort(404)
        return render_template('doc.html', document=document)
 
-The first thing to notice is that the *docname* is just the request path.  This
-makes accessing the correct document easy from a single view.  If the user is
-authenticated, then the username and moderation status are passed along with the
-docname to :meth:`~.WebSupport.get_document`.  The web support package will then
-add this data to the ``COMMENT_OPTIONS`` that are used in the template.
+.. The first thing to notice is that the *docname* is just the request path.  This
+   makes accessing the correct document easy from a single view.  If the user is
+   authenticated, then the username and moderation status are passed along with the
+   docname to :meth:`~.WebSupport.get_document`.  The web support package will then
+   add this data to the ``COMMENT_OPTIONS`` that are used in the template.
+
+まず、 *docname* が要求されたパスを表すことに気づきます。これにより、正しいドキュメントへのアクセスが行えます。もしユーザの認証が行われていたら、ユーザ名とモデレート権限情報が :meth:`~.WebSupport.get_document` に渡されます。ウェブサポートパッケージは、テンプレートの中で使用される ``COMMENT_OPTIONS`` をこのデータに付加します。
 
 .. note::
 
-   This only works works if your documentation is served from your
-   document root. If it is served from another directory, you will
-   need to prefix the url route with that directory, and give the `docroot`
-   keyword argument when creating the web support object::
+   .. This only works works if your documentation is served from your
+      document root. If it is served from another directory, you will
+      need to prefix the url route with that directory, and give the `docroot`
+      keyword argument when creating the web support object:
+
+   このプログラムはドキュメントがルートで提供される場合にのみ動作します。もし、他のディレクトリからドキュメントを提供したい場合には、URLのプリフィックスを指定する必要があります。これは、ウェブサポートオブジェクトを作成する時に、 `docroot` キーワード引数として与えます::
 
       support = WebSupport(..., docroot='docs')
 
       @app.route('/docs/<path:docname>')
 
 
-Performing Searches
-~~~~~~~~~~~~~~~~~~~
+.. Performing Searches
+   ~~~~~~~~~~~~~~~~~~~
 
-To use the search form built-in to the Sphinx sidebar, create a function to
-handle requests to the url 'search' relative to the documentation root.  The
-user's search query will be in the GET parameters, with the key `q`.  Then use
-the :meth:`~sphinx.websupport.WebSupport.get_search_results` method to retrieve
-search results. In `Flask <http://flask.pocoo.org/>`_ that would be like this::
+検索の実行
+~~~~~~~~~~
+
+.. To use the search form built-in to the Sphinx sidebar, create a function to
+   handle requests to the url 'search' relative to the documentation root.  The
+   user's search query will be in the GET parameters, with the key `q`.  Then use
+   the :meth:`~sphinx.websupport.WebSupport.get_search_results` method to retrieve
+   search results. In `Flask <http://flask.pocoo.org/>`_ that would be like this::
+
+Sphinxサイドバーの検索機能を使うと、ドキュメントルート以下の 'search' というパスに対するリクエストが発生します。ユーザの検索クエリーは、GETパラメータの `q` キーに格納されています。 :meth:`~sphinx.websupport.WebSupport.get_search_results` メソッドに渡すと、検索結果が得られます。 `Flask <http://flask.pocoo.org/>`_ では次のようになります::
 
    @app.route('/search')
    def search():
        document = support.get_search_results(q)
        return render_template('doc.html', document=document)
 
-Note that we used the same template to render our search results as we did to
-render our documents.  That's because :meth:`~.WebSupport.get_search_results`
-returns a context dict in the same format that :meth:`~.WebSupport.get_document`
-does.
+.. Note that we used the same template to render our search results as we did to
+   render our documents.  That's because :meth:`~.WebSupport.get_search_results`
+   returns a context dict in the same format that :meth:`~.WebSupport.get_document`
+   does.
 
+ドキュメントと検索結果の表示には、同じテンプレートを使用しています。これは、 :meth:`~.WebSupport.get_search_results` メソッドが、 :meth:`~.WebSupport.get_document` と同じ形式のコンテキスト辞書を返すからです。
 
-Comments & Proposals
-~~~~~~~~~~~~~~~~~~~~
 
-Now that this is done it's time to define the functions that handle the AJAX
-calls from the script.  You will need three functions.  The first function is
-used to add a new comment, and will call the web support method
-:meth:`~.WebSupport.add_comment`::
+.. Comments & Proposals
+   ~~~~~~~~~~~~~~~~~~~~
+
+コメント&提案
+~~~~~~~~~~~~~~
+
+.. Now that this is done it's time to define the functions that handle the AJAX
+   calls from the script.  You will need three functions.  The first function is
+   used to add a new comment, and will call the web support method
+   :meth:`~.WebSupport.add_comment`::
+
+それでは、コメントなどをAJAXで処理するための関数を定義します。3つの関数を定義する必要があります。1つ目は、新しいコメントが投稿されたときに、ウェブサポートオブジェクトの :meth:`~.WebSupport.add_comment` メソッドを呼び出すものです::
 
    @app.route('/docs/add_comment', methods=['POST'])
    def add_comment():
                                      username=username, proposal=proposal)
        return jsonify(comment=comment)
 
-You'll notice that both a `parent_id` and `node_id` are sent with the
-request. If the comment is being attached directly to a node, `parent_id`
-will be empty. If the comment is a child of another comment, then `node_id`
-will be empty. Then next function handles the retrieval of comments for a
-specific node, and is aptly named
-:meth:`~sphinx.websupport.WebSupport.get_data`::
+.. You'll notice that both a `parent_id` and `node_id` are sent with the
+   request. If the comment is being attached directly to a node, `parent_id`
+   will be empty. If the comment is a child of another comment, then `node_id`
+   will be empty. Then next function handles the retrieval of comments for a
+   specific node, and is aptly named
+   :meth:`~sphinx.websupport.WebSupport.get_data`:
+
+リクエストには、 `parent_id` と `node_id` を送っています。コメントが他のノードに直接追加された場合には、 `parent_id` は空になります。また、コメントが他のコメントの子供として付加された場合には、 `node_id` が空になります。次の関数は、 :meth:`~sphinx.websupport.WebSupport.get_data` メソッドを利用して、特定のノードに対するコメントを取り扱います::
 
     @app.route('/docs/get_comments')
     def get_comments():
         username = g.user.name if g.user else None
         moderator = g.user.moderator if g.user else False
         node_id = request.args.get('node', '')
-        data = support.get_data(parent_id, user_id)
+        data = support.get_data(parent_id, node_id)
         return jsonify(**data)
 
-The final function that is needed will call :meth:`~.WebSupport.process_vote`,
-and will handle user votes on comments::
+.. The final function that is needed will call :meth:`~.WebSupport.process_vote`,
+   and will handle user votes on comments::
+
+最後の関数は、 :meth:`~.WebSupport.process_vote` を呼び出して、コメントに対するユーザの投票を取り扱う関数です::
 
    @app.route('/docs/process_vote', methods=['POST'])
    def process_vote():
        return "success"
 
 
-Comment Moderation
-~~~~~~~~~~~~~~~~~~
+.. Comment Moderation
+   ~~~~~~~~~~~~~~~~~~
 
-By default, all comments added through :meth:`~.WebSupport.add_comment` are
-automatically displayed.  If you wish to have some form of moderation, you can
-pass the `displayed` keyword argument::
+コメントのモデレート
+~~~~~~~~~~~~~~~~~~~~
+
+.. By default, all comments added through :meth:`~.WebSupport.add_comment` are
+   automatically displayed.  If you wish to have some form of moderation, you can
+   pass the `displayed` keyword argument:
+
+デフォルトでは、 :meth:`~.WebSupport.add_comment` を使って追加したすべてのコメントは表示されます。もし、モデレーションを行って、承認されたコメントだけを表示したいのであれば、 `displayed` キーワード引数を渡します::
 
    comment = support.add_comment(text, node_id='node_id',
                                  parent_id='parent_id',
                                  username=username, proposal=proposal,
                                  displayed=False)
 
-You can then create a new view to handle the moderation of comments.  It
-will be called when a moderator decides a comment should be accepted and
-displayed::
+.. You can then create a new view to handle the moderation of comments.  It
+   will be called when a moderator decides a comment should be accepted and
+   displayed::
+
+コメントのモデレートを取り扱うビューを追加する必要があります。モデレータがコメントを受け入れて、表示するかどうかを決定するときに、この関数が呼び出されます::
 
    @app.route('/docs/accept_comment', methods=['POST'])
    def accept_comment():
        support.accept_comment(comment_id, moderator=moderator)
        return 'OK'
 
-Rejecting comments happens via comment deletion.
+.. Rejecting comments happens via comment deletion.
 
-To perform a custom action (such as emailing a moderator) when a new comment is
-added but not displayed, you can pass callable to the :class:`~.WebSupport`
-class when instantiating your support object::
+リジェクトされると、コメントは削除されます。
+
+.. To perform a custom action (such as emailing a moderator) when a new comment is
+   added but not displayed, you can pass callable to the :class:`~.WebSupport`
+   class when instantiating your support object:
+
+非表示の新しいコメントが追加されたときに、Eメールによるモデレートなど、カスタムのアクションを行いたい場合には、 :class:`~.WebSupport` のインスタンスを作る時に、呼び出し可能なオブジェクトを渡します::
 
    def moderation_callback(comment):
        """Do something..."""
 
    support = WebSupport(..., moderation_callback=moderation_callback)
 
-The moderation callback must take one argument, which will be the same comment
-dict that is returned by :meth:`add_comment`.
+.. The moderation callback must take one argument, which will be the same comment
+   dict that is returned by :meth:`add_comment`.
+
+このコールバック関数は、 :meth:`add_comment` が返すのと同じ形式の辞書を引数として受け取ります。
+

File docjp/web/searchadapters.rst

View file
 
 .. currentmodule:: sphinx.websupport.search
 
-Search Adapters
-===============
+.. Search Adapters
+   ===============
 
-To create a custom search adapter you will need to subclass the
-:class:`BaseSearch` class.  Then create an instance of the new class and pass
-that as the `search` keyword argument when you create the :class:`~.WebSupport`
-object::
+検索アダプタ
+============
+
+.. To create a custom search adapter you will need to subclass the
+   :class:`BaseSearch` class.  Then create an instance of the new class and pass
+   that as the `search` keyword argument when you create the :class:`~.WebSupport`
+   object:
+
+カスタムの検索アダプタを作成したい場合にには、 :class:`BaseSearch` クラスのサブクラスを作成する必要があります。その後、新しいクラスのインスタンスを作成し、 :class:`~.WebSupport` オブジェクトのを作る時に、 `search` キーワード引数で渡します::
 
    support = WebSupport(srcdir=srcdir,
                         builddir=builddir,
                         search=MySearch())
 
-For more information about creating a custom search adapter, please see the
-documentation of the :class:`BaseSearch` class below.
+.. For more information about creating a custom search adapter, please see the
+   documentation of the :class:`BaseSearch` class below.
+
+カスタムの検索アダプタを作る際のより詳しい情報は、これから説明する :class:`BaseSearch` クラスのドキュメントを参照してください。
 
 .. class:: BaseSearch
 
-   Defines an interface for search adapters.
+   .. Defines an interface for search adapters.
 
+   検索アダプタのインタフェースを定義しています。
 
-BaseSearch Methods
-~~~~~~~~~~~~~~~~~~
 
-   The following methods are defined in the BaseSearch class. Some methods do
-   not need to be overridden, but some (:meth:`~BaseSearch.add_document` and
-   :meth:`~BaseSearch.handle_query`) must be overridden in your subclass. For a
-   working example, look at the built-in adapter for whoosh.
+.. BaseSearch Methods
+   ~~~~~~~~~~~~~~~~~~
+
+BaseSearchのメソッド
+~~~~~~~~~~~~~~~~~~~~
+
+   .. The following methods are defined in the BaseSearch class. Some methods do
+      not need to be overridden, but some (:meth:`~BaseSearch.add_document` and
+      :meth:`~BaseSearch.handle_query`) must be overridden in your subclass. For a
+      working example, look at the built-in adapter for whoosh.
+
+   これらのメソッドがBaseSearchクラスに定義されています。いくつかのメソッドはオーバーライドする必要はありませんが、サブクラスでオーバーライドしなければならないもの(:meth:`~BaseSearch.add_document` , :meth:`~BaseSearch.handle_query`)もあります。組み込みのwhoosh検索アダプタが、動作可能なサンプルとなっています。
 
 .. automethod:: BaseSearch.init_indexing
 

File docjp/web/storagebackends.rst

View file
 
 .. currentmodule:: sphinx.websupport.storage
 
-Storage Backends
-================
+.. Storage Backends
+   ================
 
-To create a custom storage backend you will need to subclass the
-:class:`StorageBackend` class.  Then create an instance of the new class and
-pass that as the `storage` keyword argument when you create the
-:class:`~.WebSupport` object::
+ストレージバックエンド
+======================
+
+.. To create a custom storage backend you will need to subclass the
+   :class:`StorageBackend` class.  Then create an instance of the new class and
+   pass that as the `storage` keyword argument when you create the
+   :class:`~.WebSupport` object:
+
+カスタムのストレージバックエンドを作るには、 :class:`StorageBackend` クラスのサブクラスを作ります。その後、新しいクラスのインスタンスを作成し、 :class:`~.WebSupport` オブジェクトのを作る時に、 `storage` キーワード引数で渡します::
 
    support = WebSupport(srcdir=srcdir,
                         builddir=builddir,
                         storage=MyStorage())
 
-For more information about creating a custom storage backend, please see the
-documentation of the :class:`StorageBackend` class below.
+.. For more information about creating a custom storage backend, please see the
+   documentation of the :class:`StorageBackend` class below.
+
+カスタムのストレージバックエンドを作る際のより詳しい情報は、これから説明する :class:`StorageBackend` クラスのドキュメントを参照してください。
 
 .. class:: StorageBackend
 
-   Defines an interface for storage backends.
+   .. Defines an interface for storage backends.
 
+   ストレージバックエンドのインタフェースを定義しています。
 
-StorageBackend Methods
-~~~~~~~~~~~~~~~~~~~~~~
+
+.. StorageBackend Methods
+   ~~~~~~~~~~~~~~~~~~~~~~
+
+StorageBackendのメソッド
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automethod:: StorageBackend.pre_build
 

File docjp/websupport.rst

View file
 .. _websupport:
 
-Sphinx Web Support
-==================
+.. Sphinx Web Support
+   ==================
+
+Sphinxウェブサポート
+====================
 
 .. versionadded:: 1.1
 
-Sphinx provides a Python API to easily integrate Sphinx documentation into your
-web application.  To learn more read the :ref:`websupportquickstart`.
+.. Sphinx provides a Python API to easily integrate Sphinx documentation into your
+   web application.  To learn more read the :ref:`websupportquickstart`.
+
+SphinxはSphinxドキュメントをウェブアプリケーションに簡単に組み込めるようにするための、Python APIを提供しています。詳しくは、 :ref:`websupportquickstart` を参照してください。
 
 .. toctree::