zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

doc: proofread of the all reST sources (no content change)

Browse source 
Normalize reST sources with best practice and KISS in mind.

to name a few points:

- simplify reST tables
- make use of ``literal`` markup for monospace rendering
- fix code-blocks for better rendering in HTML
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- drop useless indentation of lists
- ...

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2019-12-12 19:20:56 +01:00
parent 0011890043
commit e9fff4fde6
17 changed files with 700 additions and 753 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/dev/translation.rst
View file

@ -1,28 +1,36 @@
.. _translation:
===========
Translation
===========
.. _searx@transifex: https://www.transifex.com/asciimoo/searx/
Translation currently takes place on `searx@transifex`_
Requirements
------------
============
* Transifex account
* Installed CLI tool of Transifex
* Transifex account
* Installed CLI tool of Transifex
Init Transifex project
----------------------
======================
After installing ``transifex`` using pip, run the following command to initialize the project.
After installing ``transifex`` using pip, run the following command to
initialize the project.
.. code:: shell
.. code:: sh
tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
After ``$HOME/.transifexrc`` is created, get a Transifex API key and insert it into the configuration file.
After ``$HOME/.transifexrc`` is created, get a Transifex API key and insert it
into the configuration file.
Create a configuration file for ``tx`` named ``$HOME/.tx/config``.
.. code:: shell
.. code:: ini
[main]
host = https://www.transifex.com
@ -42,20 +50,22 @@ Then run ``tx set``:
Update translations
-------------------
===================
To retrieve the latest translations, pull it from Transifex.
.. code:: shell
.. code:: sh
tx pull -a
tx pull -a
Then check the new languages. If strings translated are not enough, delete those folders, because
those should not be compiled. Call the command below to compile the ``.po`` files.
Then check the new languages. If strings translated are not enough, delete those
folders, because those should not be compiled. Call the command below to compile
the ``.po`` files.
.. code:: shell
pybabel compile -d searx/translations
pybabel compile -d searx/translations
After the compilation is finished commit the ``.po`` and ``.mo`` files and create a PR.
After the compilation is finished commit the ``.po`` and ``.mo`` files and
create a PR.