README.rst

phpMyAdmin - localized documentation

This repository contains localized documentation for phpMyAdmin. It is based on master document placed in phpmyadmin repository.

To translate edit your language file in po directory, changes will be propagated to generated documents. You can also translate online at <https://hosted.weblate.org/projects/phpmyadmin/documentation/> and your changes will be merged to Git.

Requirements

For manipulating with translations, you need gettext and sphinx installed.

Usage

To start new translation,

• Add it to the LANGUAGES section of the Makefile.
• Copy one of the language folders in ./docs/ to a new folder (named with the proper language code). This will maintain many symlinked files in that folder and one regular file config.py.
• Edit config.py to change the language = section with the correct language name.
• In the ./po/ folder, copy documentation.pot to create a new .po file. You may have to also create a .mo file, but I think that happens automatically on the build server.
• Copy one of the folders in ./translated/ to a new folder. This again creates many symlinks.

To regenerate mofiles run:

make

To obtain statistics about current translations run:

./locales-stats

To update documentation run:

# Force Weblate to commit changes, requires wlc to be installed
wlc commit
# Pull changes from Weblate
git pull
# Update phpMyAdmin submodule
git submodule update --remote
# Update po files to match current docs
make

This automatically updates po files, generates mo files and synchronizes sources of the documentation. Review changes and commit them using:

git commit -a -m 'Update documentation to match master'

To build documentation in given language (for example Czech):

make html-cs

You can also invoke sphinx-build manually:

sphinx-build docs/cs/ output/cs/

You can also build all documentation at once:

make html

You can also browse translated documentation online at <https://docs.phpmyadmin.net/>.