summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJustin Mayer <entroP@gmail.com>2020-04-21 05:36:28 +0200
committerJustin Mayer <entroP@gmail.com>2020-04-21 05:36:28 +0200
commit021ef45f758592966631ac0499530180e2cb7421 (patch)
treea6ee038cb395cab164c37db1c2c65fbf70e01007 /docs
parent7e248861902d4ad207df6734078f1db76e33484e (diff)
downloadpelican-021ef45f758592966631ac0499530180e2cb7421.tar.gz
Tidy SLUGIFY_* settings documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/settings.rst14
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/settings.rst b/docs/settings.rst
index 8c021563..5b255dcc 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -615,24 +615,22 @@ corresponding ``*_URL`` setting as string, while others hard-code them:
``'archives.html'``, ``'authors.html'``, ``'categories.html'``,
``'tags.html'``.
-
.. data:: SLUGIFY_SOURCE = 'title'
- Specifies where you want the slug to be automatically generated from. Can be
- set to ``title`` to use the 'Title:' metadata tag or ``basename`` to use the
+ Specifies from where you want the slug to be automatically generated. Can be
+ set to ``title`` to use the "Title:" metadata tag or ``basename`` to use the
article's file name when creating the slug.
.. data:: SLUGIFY_USE_UNICODE = False
- Allow unicode characters in slugs. Set ``True`` to keep unicode characters
- in auto-generated slugs. Otherwise, unicode characters will be replaced
+ Allow Unicode characters in slugs. Set ``True`` to keep Unicode characters
+ in auto-generated slugs. Otherwise, Unicode characters will be replaced
with ASCII equivalents.
-
.. data:: SLUGIFY_PRESERVE_CASE = False
- Preserve uppercase characters in the slugs. Set ``True`` to keep the
- uppercase characters in the ``SLUGIFY_SOURCE`` as is.
+ Preserve uppercase characters in slugs. Set ``True`` to keep uppercase
+ characters from ``SLUGIFY_SOURCE`` as-is.
.. data:: SLUG_REGEX_SUBSTITUTIONS = [
(r'[^\\w\\s-]', ''), # remove non-alphabetical/whitespace/'-' chars