https://github.com/phpmyadmin/localized_docs

Localized documentation
https://github.com/phpmyadmin/localized_docs

Last synced: about 2 months ago
JSON representation

Localized documentation

• Host: GitHub
• URL: https://github.com/phpmyadmin/localized_docs
• Owner: phpmyadmin
• Created: 2012-02-05T09:17:51.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2026-01-18T01:32:22.000Z (2 months ago)
• Last Synced: 2026-01-18T13:51:13.607Z (2 months ago)
• Language: Makefile
• Homepage: https://hosted.weblate.org/projects/phpmyadmin/documentation/
• Size: 399 MB
• Stars: 72
• Watchers: 14
• Forks: 53
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
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

 and your changes

will be merged to Git.

.. image:: https://hosted.weblate.org/widget/phpmyadmin/documentation/svg-badge.svg

    :alt: Translation status

    :target: https://hosted.weblate.org/engage/phpmyadmin/

.. image:: https://github.com/phpmyadmin/localized_docs/actions/workflows/build.yml/badge.svg?branch=master

    :alt: Build documentation

    :target: https://github.com/phpmyadmin/localized_docs/actions/workflows/build.yml?query=branch%3Amaster

.. image:: https://readthedocs.org/projects/phpmyadmin/badge/?version=latest

    :target: http://docs.phpmyadmin.net/en/latest/?badge=latest

    :alt: Documentation Status

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:

.. code-block:: sh

    make

To obtain statistics about current translations run:

.. code-block:: sh

    ./locales-stats

To update documentation run:

.. code-block:: sh

    # 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:

.. code-block:: sh

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

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

.. code-block:: sh

    make html-cs

You can also invoke sphinx-build manually:

.. code-block:: sh

    sphinx-build docs/cs/ output/cs/

You can also build all documentation at once:

.. code-block:: sh

    make html

You can also browse translated documentation online at .