django-rpi-tph-docs

Documents for my django-rpi-tph-monitor project.

English document(default)

repository

• HTTPS:
  • https://github.com/mitsuhisaT/django-rpi-tph-docs.git
• SSH
  • git@github.com:mitsuhisaT/django-rpi-tph-docs.git

branch

$ git checkout i10n/en

Another languages

For example Japanese.

Checkout another language branch.

$ git checkout i10n/ja

If first time, you must create branch and new repository(project).

$ git checkout -b i10n/{language code} --track remote/i10n/{language code}

Please read Internationalization.

Generate po files.

$ cd docs
$ make gettext
$ sphinx-intl update -p _build/gettext -l ja

Commit and Push po files.

$ git add locale/ja/LC_MESSAGES/*.po
$ git commit -m "docs: because update and add some describes."
$ git push

merge develop

$ git checkout develop
$ git mearge i10n/ja
$ git push

Last, change default branch i10n/en.

$ git checkout i10n/en

Another language document

For example Japanese.

Clone repository

$ git clone git@github.com:mitsuhisaT/django-rpi-tph-docs-l10n-ja.git

Change repository directory.

$ cd django-rpi-tph-docs-l10n-ja

Set up for Sync main repository

$ git remote -v
origin	git@github.com:mitsuhisaT/django-rpi-tph-docs-l10n-ja.git (fetch)
origin	git@github.com:mitsuhisaT/django-rpi-tph-docs-l10n-ja.git (push)

Add upstream.

$ git remote add upstream git@github.com:mitsuhisaT/django-rpi-tph-docs.git
$ git remote -v
origin	git@github.com:mitsuhisaT/django-rpi-tph-docs-l10n-ja.git (fetch)
origin	git@github.com:mitsuhisaT/django-rpi-tph-docs-l10n-ja.git (push)
upstream	git@github.com:mitsuhisaT/django-rpi-tph-docs.git (fetch)
upstream	git@github.com:mitsuhisaT/django-rpi-tph-docs.git (push)

$ git branch --all
* i10n/ja
  remotes/origin/HEAD -> origin/i10n/ja
  remotes/origin/develop
  remotes/origin/i10n/en
  remotes/origin/i10n/ja
  remotes/origin/main
  remotes/upstream/develop
  remotes/upstream/i10n/en
  remotes/upstream/i10n/ja
  remotes/upstream/main

Syncronize upstream, document main repository.

$ git fetch upstream
From github.com:mitsuhisaT/django-rpi-tph-docs
   18c17fb..537f31c  develop    -> upstream/develop
   18c17fb..dfea83c  i10n/ja    -> upstream/i10n/ja

$ git merge upstream/develop
Updating 18c17fb..537f31c
Fast-forward
 README.md                                    | 13 +++++++++++--
 docs/locale/ja/LC_MESSAGES/gettingstarted.po | 50 ++++++++++++++++++++++++--------------------------
 docs/locale/ja/LC_MESSAGES/index.po          | 20 ++++++++------------
 docs/locale/ja/LC_MESSAGES/prepare.po        |  4 ++--
 docs/requirements.txt                        |  2 +-
 5 files changed, 46 insertions(+), 43 deletions(-)

$ git push

$ git merge upstream/i10n/ja
Already up to date.
$ git push
Everything up-to-date

change branch

$ git checkout i10n/{language code}

Then, you can edit po files in locale/{language code}/LC_MESSAGES for translate Japanese.

After translate, you must commit, push and pull request.