Type sphinx-intl without arguments, options to show command help.
sphinx-intlsphinx-intl [OPTIONS] COMMAND [ARGS]...
Options
Sphinx conf.py file to read a locale directory setting.
Pass tags to conf.py, as same as passed to sphinx-build -t option.
Environment variables
Provide a default for
-t
Build specified language’s po files into mo.
sphinx-intl build [OPTIONS]
Options
locale directories that allow comma separated string. This option override locale_dir in conf.py setting if provided. Default is empty list.
'locales'
mo files directory where files are written. Default is to match the ‘–locale-dir’ path.
Target language to update po files. Default is ALL.
Environment variables
Provide a default for
-d
Provide a default for
--output-dir
Provide a default for
-l
Create $HOME/.transifexrc (deprecated)
sphinx-intl create-transifexrc [OPTIONS]
Options
Required Your transifex token. (DEPRECATED)
Environment variables
Provide a default for
--transifex-token
Create ./.tx/config
sphinx-intl create-txconfig [OPTIONS]stat
Print statistics for all po files.
sphinx-intl stat [OPTIONS]
Options
locale directories that allow comma separated string. This option override locale_dir in conf.py setting if provided. Default is empty list.
'locales'
Target language to update po files. Default is ALL.
Environment variables
Provide a default for
-d
Provide a default for
-l
Update specified language’s po files from pot.
For examples:
sphinx-intl update -l de -l ja
sphinx-intl update -l de,ja
sphinx-intl update [OPTIONS]
Options
locale directories that allow comma separated string. This option override locale_dir in conf.py setting if provided. Default is empty list.
'locales'
pot files directory which is generated by sphinx. Default is ‘pot’ directory under ‘–locale-dir’ path.
Target language to update po files. Default is ALL.
The maximum line width for the po files, 0 or a negative number disable line wrapping
76
Remove obsolete #~ messages.
The number of CPUs to use for updates. 0 means all
0
Environment variables
Provide a default for
-d
Provide a default for
--pot-dir
Provide a default for
-l
Provide a default for
-w
Provide a default for
--no-obsolete
Provide a default for
-j
Update resource sections of ./.tx/config.
sphinx-intl update-txconfig-resources [OPTIONS]
Options
Required Your transifex organization name.
Required Your transifex project name.
locale directories that allow comma separated string. This option override locale_dir in conf.py setting if provided. Default is empty list.
'locales'
pot files directory which is generated by sphinx. Default is ‘pot’ directory under ‘–locale-dir’ path.
Environment variables
Provide a default for
--transifex-organization-name
Provide a default for
--transifex-project-name
Provide a default for
-d
Provide a default for
--pot-dir
All command-line options can be set with environment variables using the format SPHINXINTL_<UPPER_LONG_NAME>
. Dashes (-) have to be replaced with underscores (_).
For example, to set the languages:
export SPHINXINTL_LANGUAGE=de,ja
This is the same as passing the option to sphinx-intl directly:
sphinx-intl <command> --language=de --language=jaSphinx conf.py
Add below settings to sphinx document’s conf.py if they do not exists:
locale_dirs = ['locale/'] #for example gettext_compact = False #optionalMakefile / make.bat
make gettext will generate pot files into _build/gettext directory, however it is much convenient if pot files are generated into the locale/pot directory. You can achieve this by replacing _build/gettext with locale/pot in your Makefile and/or make.bat that was generated by sphinx-quickstart.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4