@@ -66,31 +66,34 @@ brew install gettext
66
66
The workflow itself
67
67
```
68
68
# create .tx config
69
- tx init
70
- # or when just want to update a ressource
71
- tx set --source -r <project_slug.resource_slug> -l <lang> <file>
69
+ $ tx init
72
70
73
- make clean
71
+ # ensure clean enviroment
72
+ $ make clean
74
73
75
- # this will generate the strings from the *.rst files
76
- make gettext
74
+ # generate the strings from the *.rst files
75
+ $ make gettext
77
76
78
- # this will generate the locales (DE|EN)
79
- sphinx-intl update -p _build/locale/ -l de -l en
77
+ # OPTIONAL: if you have to adapt a new locale, run
78
+ sphinx-intl update -p _build/locale/ -l de
80
79
81
- # this will update the ressource files from the pot dir
82
- sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name zammad-admin-documentation
80
+ # update the resource files from the pot dir
81
+ $ sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name zammad-admin-documentation
83
82
84
83
# push to transifex (if configured)
85
- tx push -s
84
+ $ tx push -s
86
85
86
+ # Below pull options by default ignore unreviewed (see https://docs.transifex.com/client/pull#getting-different-file-variants )
87
87
# after translation pull needed languages from transifex
88
- tx pull -l en
88
+ $ tx pull -l en
89
89
90
- # manual build based upon the language (_build/html/)
91
- make -e SPHINXOPTS="-D language='de'" html
92
- make -e SPHINXOPTS="-D language='en'" html
90
+ # build the .MO files for use with readthedocs
91
+ # (After a successful build, push to this repo and readthedocs will update itself.)
92
+ $ sh build_mo.sh
93
93
94
+ # manual language-based build (`_build/html/`) (for testing)
95
+ $ make -e SPHINXOPTS="-D language='de'" html
96
+ $ make -e SPHINXOPTS="-D language='en'" html
94
97
```
95
98
96
99
If you have a problem, please create an issue. Thanks.
0 commit comments