Add additional asciify documentation

This was proposed in #929 but never dealt with, so after going through some confusion around this myself I figured it's about time.
This commit is contained in:
emiham 2021-09-17 13:33:31 +02:00 committed by GitHub
parent 7548820e58
commit e48d76a1cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -165,6 +165,10 @@ take place before applying the :ref:`replace` configuration and are roughly
equivalent to wrapping all your path templates in the ``%asciify{}``
:ref:`template function <template-functions>`.
This uses the `unidecode module`_ which is language agnostic, so some
characters may be transliterated from a different language than expected.
For example, Japanese kanji will usually use their Chinese readings.
Default: ``no``.
.. _unidecode module: https://pypi.org/project/Unidecode