Skip to content
Newer
Older
100644 54 lines (35 sloc) 1.64 KB
9165a88 @certik Docs: use gettext for tutorial.txt
certik authored Dec 16, 2011
1 How to Build Documentation
2 ==========================
3
4 To make the html documentation, install the prerequisites, e.g. on
5 Debian/Ubuntu (similarly for other distributions)::
6
7 apt-get install python-sphinx texlive-latex-recommended dvipng
8
9 and do::
10
11 make html
12
13 and to view it, do::
14
15 epiphany _build/html/index.html
16
17 How to Build Translated Tutorial
18 ================================
19
20 To build the translated tutorial, build the documentation
7871647 @certik Fix the doc/README.rst formatting
certik authored Dec 17, 2011
21 using ``make html`` and then just run::
9165a88 @certik Docs: use gettext for tutorial.txt
certik authored Dec 16, 2011
22
23 make htmli18n
24
7871647 @certik Fix the doc/README.rst formatting
certik authored Dec 17, 2011
25 This will create ``tutorial.cs.html``, ``tutorial.ru.html`` (and so on for all
26 languages) in the ``_build/html/`` directory. The input is the English tutorial
6b41922 @asmeurer Use rst instead of txt as the extension for the Sphinx docs
asmeurer authored Jul 2, 2012
27 ``tutorial.rst`` and the .po files ``tutorial.cs.po``, ``tutorial.ru.po``, etc.
9165a88 @certik Docs: use gettext for tutorial.txt
certik authored Dec 16, 2011
28 You can freely change the English tutorial -- sentences that are not translated
29 will remain in English in the translated verions.
30
7871647 @certik Fix the doc/README.rst formatting
certik authored Dec 17, 2011
31 Note: ``make htmli18n`` is currently quite slow, so it is not run by default.
32 However, this can be trivially implemented by modifying the ``Makefile``.
9165a88 @certik Docs: use gettext for tutorial.txt
certik authored Dec 16, 2011
33
34 How to Update Translations
35 ==========================
36
7871647 @certik Fix the doc/README.rst formatting
certik authored Dec 17, 2011
37 In order to update translations, you first need to generate the
38 ``tutorial.pot`` template by::
9165a88 @certik Docs: use gettext for tutorial.txt
certik authored Dec 16, 2011
39
40 make gettext
41
47e2a2a @certik Doc: Update documentation for updating translation
certik authored Dec 27, 2011
42 Then you need to translate it if you are creating a new language
43 translation. If you are just updating a translation, for example the
44 ``tutorial.cs.po``, just do::
45
46 msgmerge -U tutorial.cs.po tutorial.pot
47
48 This will create a new ``tutorial.cs.po`` by using the template
49 ``tutorial.pot`` and reusing the old translations from old ``tutorial.cs.po``
50 (if they still work) and leaving the rest untranslated.
51
52 Then just build it using ``make htmli18n`` (see the
7871647 @certik Fix the doc/README.rst formatting
certik authored Dec 17, 2011
53 previous section).
Something went wrong with that request. Please try again.