You will need:
- python 3.6 or above.
- pip must be configured
- scons (pip install scons)
- markdown (pip install markdown)
- msgfmt utility. The easiest way of getting it is by installing git bash and choosing to include bash tools at command prompt
Once you have everything installed, issuing scons at the root of the project should build the addon and generate docs.
Assuming you have everything set up to build the addom (see previous topic) issuing scons pot should generate a pot file at the root project directory. It is them possible to generate and contribute the .po files for your language. Current languages can be found at /addon/locale directory
Documentation translations are generated from .tpl.md (not from .md) files. This is why, except from this file (read.md) at the root of the project, you won't find other .md files.
The .tpl.md files are normal markdown files with one addition: if you use ${[var]} within its text, [var] will be replaced by a var with the same name defined in buildvars.py when the corresponding md and.html files are generated.
If no variable with that name exists, the substitution doesn't take place.
This is useful for example to generate links and titles with the addon version included without having to rewrite documentation.
To translate documentation, grab the readme.tpl.md file at the root of the project and translate it. The translated file must be named readme.tpl.md and must be placed inside the addon/doc/[lang] directory.
The ${[xxx]} vars need to stay untouched. To generate the docs, issue scons and the markdown and HTML will be generated.