Skip to content
AiiDA localization
Python Jupyter Notebook Makefile Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx connect to aiida-core May 23, 2019
aiida_core @ adbae81 restapi and working Aug 18, 2019
source restapi and working Aug 18, 2019
.gitignore connect to aiida-core May 23, 2019
.gitmodules add aiida_core as submodule May 15, 2019
.readthedocs.yml no pdf build May 23, 2019
LICENSE Initial commit May 15, 2019
LICENSE.txt init May 15, 2019
Makefile a repository May 15, 2019
README.md concept part re translate Jul 12, 2019
conf.py.tmpl update concept.po May 29, 2019
requirements_for_rtd.txt a repository May 15, 2019
rtd_settings.py rtd_setting May 23, 2019
update_source.sh new version and new po files Jul 17, 2019

README.md

AiiDA-l10n-zh_CN

Documentation Status

Transifex is used as translation platform. The workflow is described as following, to process the translation work of AiiDA documentation.

Workflow for transifex translators

  1. Login to transifex service.
  2. Go to AiiDA documentation translation page.
  3. Click Request language and fill form.
  4. Wait acceptance by transifex AiiDA Docs translation maintainers.
  5. (After acceptance) Translate on transifex.

How to add a new localization to the documentation?

This repository is a template for how to add a new localization.

0. Create a github repository 'aiida-l10n-<lang>'

The source code of documentation comes from aiida_core. Therefore, submodule the aiida_core in the new created repository.

$ git submodule add "https://github.com/aiidateam/aiida_core.git"
$ git submodule init
$ git submodule update

You can update submodule by running:

git submodule foreach git pull

The submodule is just a pointer to a particular commit of the submodule's repository. To point to a latest version refer to Git submodules: Specify a branch/tag. Running:

aiida-l10n-<lang> $ cd aiida_core
aiida_core $ git checkout develop
aiida_core $ cd ..
aiida-l10n-<lang> $ git add .
aiida-l10n-<lang> $ git commit -m "moved aiida_core to develop"
aiida-l10n-<lang> > git push

Copy the source code of docs to current project. Every time when official documentation update, do this to track the latest docs code.

$ cp -R aiida_core/docs/source ./

Because the folder structure is changed, the conf.py need to be replaced by conf.py.tmpl:

cp conf.py.tmpl source/conf.py

Creating .tx/config file (used for tx pull):

$ tx init --no-interactive
$ sphinx-intl update-txconfig-resources --pot-dir build/locale --transifex-project-name aiida-documentation

make sure not to include apidoc which should not be translated in .tx/config. (manually remove these lines?)

1. Request language in transifex

https://www.transifex.com/aiidateam/aiida-documentation/languages/

Getting the .po file from transifex platform:

tx pull -l <lang>

2. A new localization project is better to include the transltion style guid as following

Chinese translation style guide(中文翻译指南)

process: 例程。目的是区别linux的进程和广义的流程的概念,是AiiDA中一个特有的基础概念。
provenance: 可验证性。表示了数据和流程是可以重复并可以追踪来源过程的。
provenance graph: 可验证性图。AiiDA生成的有可验证性的图结构。
calculation: 算例。
calculation job: 算例任务。
calculation function: 算例函数。
workflow: 工作流。
workflow function: 工作流函数。
workchain: 工作链。

...

When original documentation updated

UPDATE the source code:

$ sh update_source.sh

The content in transfix will automatically updated by travis.

You can’t perform that action at this time.