cargo-doc-l10n is a tool to generate translated documentation and help the translators to keep the documentation
up to date. The main goals are :
- Introduce a standard format for localization of documentation comments that feels natural for Rust developers
(since translators will mostly be Rust users too)
- The translation effort should have no impact for the developers of the code :
- no impact on the way to document the source code.
- localization files are in a separate directory that developers don't have to care about.
- just one command to subtitute to cargo doc
is required required to generate the localized documentation
along the original one.
- When the documentation is generated, warn about outdated or missing translations
- The translated documentation contain a warning and a reference to the current original text on items with an
outdated translation.
- A translator must be able to easily spot all the outdated translations.