Change lists, not tuples, in config settings

In the documentation, both `SOCIAL` and `LINKS` are described as a list
of tuples, but all examples show them as tuples of tuples. It makes the
most sense for them to be lists, so the examples should match the docs
going forward.

Similarly, `LOCALE` is described as a list, but the examples show it as
a tuple. Likewise, the examples should be lists, in line with the
description.
This commit is contained in:
Ilya Simpson 2025-05-31 12:20:09 +12:00
commit fca2fde2ed
5 changed files with 18 additions and 18 deletions

View file

@ -819,9 +819,9 @@ Time and Date
.. parsed-literal:: .. parsed-literal::
LOCALE = ('usa', 'jpn', # On Windows LOCALE = ['usa', 'jpn', # On Windows
'en_US', 'ja_JP' # On Unix/Linux 'en_US', 'ja_JP' # On Unix/Linux
) ]
For a list of available locales refer to `locales on Windows`_ or on For a list of available locales refer to `locales on Windows`_ or on
Unix/Linux, use the ``locale -a`` command; see manpage Unix/Linux, use the ``locale -a`` command; see manpage

View file

@ -12,20 +12,20 @@ DEFAULT_PAGINATION = 2
FEED_RSS = "feeds/all.rss.xml" FEED_RSS = "feeds/all.rss.xml"
CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml" CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml"
LINKS = ( LINKS = [
("Biologeek", "http://biologeek.org"), ("Biologeek", "http://biologeek.org"),
("Filyb", "http://filyb.info/"), ("Filyb", "http://filyb.info/"),
("Libert-fr", "http://www.libert-fr.com"), ("Libert-fr", "http://www.libert-fr.com"),
("N1k0", "http://prendreuncafe.com/blog/"), ("N1k0", "http://prendreuncafe.com/blog/"),
("Tarek Ziadé", "http://ziade.org/blog"), ("Tarek Ziadé", "http://ziade.org/blog"),
("Zubin Mithra", "http://zubin71.wordpress.com/"), ("Zubin Mithra", "http://zubin71.wordpress.com/"),
) ]
SOCIAL = ( SOCIAL = [
("twitter", "http://twitter.com/ametaireau"), ("twitter", "http://twitter.com/ametaireau"),
("lastfm", "http://lastfm.com/user/akounet"), ("lastfm", "http://lastfm.com/user/akounet"),
("github", "http://github.com/ametaireau"), ("github", "http://github.com/ametaireau"),
) ]
# global metadata to all the contents # global metadata to all the contents
DEFAULT_METADATA = {"yeah": "it is"} DEFAULT_METADATA = {"yeah": "it is"}

View file

@ -16,18 +16,18 @@ AUTHOR_FEED_ATOM = None
AUTHOR_FEED_RSS = None AUTHOR_FEED_RSS = None
# Blogroll # Blogroll
LINKS = ( LINKS = [
("Pelican", "https://getpelican.com/"), ("Pelican", "https://getpelican.com/"),
("Python.org", "https://www.python.org/"), ("Python.org", "https://www.python.org/"),
("Jinja2", "https://palletsprojects.com/p/jinja/"), ("Jinja2", "https://palletsprojects.com/p/jinja/"),
("You can modify those links in your config file", "#"), ("You can modify those links in your config file", "#"),
) ]
# Social widget # Social widget
SOCIAL = ( SOCIAL = [
("You can add links in your config file", "#"), ("You can add links in your config file", "#"),
("Another social link", "#"), ("Another social link", "#"),
) ]
DEFAULT_PAGINATION = {{default_pagination}} DEFAULT_PAGINATION = {{default_pagination}}

View file

@ -17,20 +17,20 @@ DEFAULT_DATE = (2012, 3, 2, 14, 1, 1)
FEED_ALL_RSS = "feeds/all.rss.xml" FEED_ALL_RSS = "feeds/all.rss.xml"
CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml" CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml"
LINKS = ( LINKS = [
("Biologeek", "http://biologeek.org"), ("Biologeek", "http://biologeek.org"),
("Filyb", "http://filyb.info/"), ("Filyb", "http://filyb.info/"),
("Libert-fr", "http://www.libert-fr.com"), ("Libert-fr", "http://www.libert-fr.com"),
("N1k0", "http://prendreuncafe.com/blog/"), ("N1k0", "http://prendreuncafe.com/blog/"),
("Tarek Ziadé", "http://ziade.org/blog"), ("Tarek Ziadé", "http://ziade.org/blog"),
("Zubin Mithra", "http://zubin71.wordpress.com/"), ("Zubin Mithra", "http://zubin71.wordpress.com/"),
) ]
SOCIAL = ( SOCIAL = [
("twitter", "http://twitter.com/ametaireau"), ("twitter", "http://twitter.com/ametaireau"),
("lastfm", "http://lastfm.com/user/akounet"), ("lastfm", "http://lastfm.com/user/akounet"),
("github", "http://github.com/ametaireau"), ("github", "http://github.com/ametaireau"),
) ]
# global metadata to all the contents # global metadata to all the contents
DEFAULT_METADATA = {"yeah": "it is"} DEFAULT_METADATA = {"yeah": "it is"}

View file

@ -21,20 +21,20 @@ ARTICLE_SAVE_AS = ARTICLE_URL + "index.html"
FEED_ALL_RSS = "feeds/all.rss.xml" FEED_ALL_RSS = "feeds/all.rss.xml"
CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml" CATEGORY_FEED_RSS = "feeds/{slug}.rss.xml"
LINKS = ( LINKS = [
("Biologeek", "http://biologeek.org"), ("Biologeek", "http://biologeek.org"),
("Filyb", "http://filyb.info/"), ("Filyb", "http://filyb.info/"),
("Libert-fr", "http://www.libert-fr.com"), ("Libert-fr", "http://www.libert-fr.com"),
("N1k0", "http://prendreuncafe.com/blog/"), ("N1k0", "http://prendreuncafe.com/blog/"),
("Tarek Ziadé", "http://ziade.org/blog"), ("Tarek Ziadé", "http://ziade.org/blog"),
("Zubin Mithra", "http://zubin71.wordpress.com/"), ("Zubin Mithra", "http://zubin71.wordpress.com/"),
) ]
SOCIAL = ( SOCIAL = [
("twitter", "http://twitter.com/ametaireau"), ("twitter", "http://twitter.com/ametaireau"),
("lastfm", "http://lastfm.com/user/akounet"), ("lastfm", "http://lastfm.com/user/akounet"),
("github", "http://github.com/ametaireau"), ("github", "http://github.com/ametaireau"),
) ]
# global metadata to all the contents # global metadata to all the contents
DEFAULT_METADATA = {"yeah": "it is"} DEFAULT_METADATA = {"yeah": "it is"}