File: basic.rst

package info (click to toggle)
sphinx-intl 2.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 340 kB
  • sloc: python: 1,162; makefile: 13
file content (42 lines) | stat: -rw-r--r-- 1,095 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
=====
Basic
=====

.. contents::
   :local:

Basic Features
===============

* create or update po files from pot files.
* build mo files from po files.

Optional features
==================
These features depends on the `Transifex Client`_ tool.
Please refer Installation_ section to install it.

* create ``.transifexrc`` file from environment variable, without interactive
  input.
* create ``.tx/config`` file without interactive input.
* update ``.tx/config`` file from locale/pot files automatically.
* build mo files from po files in the locale directory.

You need to use `tx` command for below features:

* ``tx push -s`` : push pot (translation catalogs) to transifex.
* ``tx pull -l ja`` : pull po (translated catalogs) from transifex.

.. _Transifex Client: https://github.com/transifex/cli


Installation
=============

It is strongly recommended to use virtualenv/venv for this procedure::

   $ pip install sphinx-intl

If you want to use `Optional Features`_, you need install Transifex CLI tool.
Please refer to `Installation instructions <https://github.com/transifex/cli>`_.