読者です 読者をやめる 読者になる 読者になる

Symfony2 ドキュメントの翻訳手順 環境準備

久しぶりにユーザ会のコンテンツを翻訳してみようと思い立ったけど
割と忘れていたので、振り返りがてらメモした手順となります。

Symfony2のドキュメントはsphinxというPython製ドキュメンテーションビルダーで
構築されています。
まずはsphinxでSymfony2のドキュメントを表示する所までの環境の準備を行います

(1)sphinxのインストール

# yum install python-pip python-setuptools
# pip-python install sphinx

(2)ドキュメントの作業ディレクトリの作成

日本語ドキュメントのリポジトリは下記となります。

https://github.com/symfony-japan/symfony-docs-ja

まずはforkボタンを押してforkします。

f:id:taka512:20120820210636p:plain


翻訳用の作業ディレクトリを作成し、forkしたリポジトリをcloneします。

$ mkdir /home/sphinx
$ cd /home/sphinx
$ git clone https://github.com/taka512/symfony-docs-ja.git

(3)sphinxプロジェクトの作成

index.rstをそのままにしておくと、プロジェクト作成の際に上書きされそうになるので
一旦退避させます。

$ cd symfony-docs-ja/
// 一旦退避
$ mv index.rst index.rst_

3つの質問以外はデフォルトで問題ないです。

// プロジェクト名
> Project name: symfony2_translate
// 作者名
> Author name(s): taka512
// プロジェクトバージョン(当日の日付でも設定しておく)
> Project version: 20120820

sphinxプロジェクトの作成

$ sphinx-quickstart
Welcome to the Sphinx 1.1.3 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]:

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/N) [n]:

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: symfony2_translate
> Author name(s): taka512

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 20120820
> Project release [20120820]:

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]:

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]:
> doctest: automatically test code snippets in doctest blocks (y/N) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]:
> coverage: checks for documentation coverage (y/N) [n]:
> pngmath: include math, rendered as PNG images (y/N) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/N) [n]:
> ifconfig: conditional inclusion of content based on config values (y/N) [n]:
> viewcode: include links to the source code of documented Python objects (y/N) [n]:

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (Y/n) [y]:
> Create Windows command file? (Y/n) [y]:

Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.
Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

退避したindexファイルを戻す

$ mv index.rst_ index.rst

(4)sphinx拡張を設定

Symfony2のドキュメントではsphinxの拡張を利用しているので設定する必要があります。

$ git clone https://github.com/fabpot/sphinx-php
$ mv sphinx-php _exts
// conf.pyファイルの一番下に追記
$ vi conf.py
sys.path.append(os.path.abspath('_exts'))

# adding PhpLexer
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# add the extensions to the list of extensions
extensions = ['sensio.sphinx.refinclude', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode']

# enable highlighting for PHP code not between ``<?php ... ?>`` by default
lexers['php'] = PhpLexer(startinline=True)
lexers['php-annotations'] = PhpLexer(startinline=True)

# use PHP as the primary domain
primary_domain = 'php'

# set url for API links
api_url = 'http://api.symfony.com/master/%s'

(5)ドキュメント(html)を生成

ここまでで準備ができましたのでドキュメントが作成できるか確認を行います。

「make html」コマンドを実行すると「_build/html」の下にhtmlファイルが書き出されます。
これをブラウザで見れるディレクトリにコピーして確認を行います。

$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 189 source files that are out of date
updating environment: 189 added, 0 changed, 0 removed
reading sources... [100%] reference/requirements

----略----

writing additional files... genindex search
copying images... [100%] images/request-flow.png
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 163 warnings.

Build finished. The HTML pages are in _build/html.

// 生成されたファイルをドキュメントルートにコピー
$ cp -r _build/html [DocumentRoot]


http://yourdomain/html」にアクセスすると「http://docs.symfony.gr.jp/symfony2/」に
あたるドキュメントが表示されます。
こんな感じに表示されたら成功です。

f:id:taka512:20120820212151p:plain


■参考

sphinxの設定
http://sphinx-users.jp/gettingstarted/index.html

sphinx拡張のインストール
http://symfony.com/doc/master/contributing/documentation/format.html

・Symfony2 ドキュメントの作り方
http://d.hatena.ne.jp/shimooka/20120621/1340252628