github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change documented type of various settings

Browse source 
- DEFUALT_METADATA, tuple -> dictionary
- OUTPUT_RETENTION, tuple -> list
- JINJA_FILTERS, list -> dictionary
- DIRECT_TEMPLATES, tuple -> list
This commit is contained in:
Kevin Yap 2015-01-17 16:20:39 -08:00
commit 88ad46fd4d
5 changed files with 18 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/settings.rst
View file

@ -64,8 +64,7 @@ Setting name (followed by default value, if any)
If set to a tuple object, the default datetime object will instead
be generated by passing the tuple to the
``datetime.datetime`` constructor.
``DEFAULT_METADATA = ()`` The default metadata you want to use for all articles
and pages.
``DEFAULT_METADATA = {}`` The default metadata you want to use for all articles and pages.
``DOCUTILS_SETTINGS = {}`` Extra configuration settings for the docutils publisher
(applicable only to reStructuredText). See `Docutils
Configuration`_ settings for more details.
@ -90,11 +89,11 @@ Setting name (followed by default value, if any)
generating new files. This can be useful in preventing older,
unnecessary files from persisting in your output. However, **this is
a destructive setting and should be handled with extreme care.**
``OUTPUT_RETENTION = ()`` A tuple of filenames that should be retained and not deleted from the
``OUTPUT_RETENTION = []`` A list of filenames that should be retained and not deleted from the
output directory. One use case would be the preservation of version
control data. For example: ``(".hg", ".git", ".bzr")``
control data. For example: ``[".hg", ".git", ".bzr"]``
``JINJA_EXTENSIONS = []`` A list of any Jinja2 extensions you want to use.
``JINJA_FILTERS = {}`` A list of custom Jinja2 filters you want to use.
``JINJA_FILTERS = {}`` A dictionary of custom Jinja2 filters you want to use.
The dictionary should map the filtername to the filter function.
For example: ``{'urlencode': urlencode_filter}``
See `Jinja custom filters documentation`_.
@ -171,12 +170,12 @@ Setting name (followed by default value, if any)
``TYPOGRIFY_IGNORE_TAGS = []`` A list of tags for Typogrify to ignore. By default
Typogrify will ignore ``pre`` and ``code`` tags. This
requires that Typogrify version 2.0.4 or later is installed
``DIRECT_TEMPLATES =`` ``('index', 'categories', 'authors', 'archives')`` List of templates that are used directly to render
``DIRECT_TEMPLATES =`` ``['index', 'categories', 'authors', 'archives']`` List of templates that are used directly to render
content. Typically direct templates are used to generate
index pages for collections of content (e.g., tags and
category index pages). If the tag and category collections
are not needed, set ``DIRECT_TEMPLATES = ('index', 'archives')``
``PAGINATED_DIRECT_TEMPLATES = ('index',)`` Provides the direct templates that should be paginated.
are not needed, set ``DIRECT_TEMPLATES = ['index', 'archives']``
``PAGINATED_DIRECT_TEMPLATES = ['index']`` Provides the direct templates that should be paginated.
``SUMMARY_MAX_LENGTH = 50`` When creating a short summary of an article, this will
be the default length (measured in words) of the text created.
This only applies if your content does not otherwise
@ -352,7 +351,7 @@ posts for the month at ``posts/2011/Aug/index.html``.
arrive at an appropriate archive of posts, without having to specify
a page name.
``DIRECT_TEMPLATES``, which are ``('index', 'tags', 'categories', 'archives')``
``DIRECT_TEMPLATES``, which are ``['index', 'tags', 'categories', 'archives']``
by default, work a bit differently than noted above. Only the ``_SAVE_AS``
settings are available, but it is available for any direct template.

8
pelican/settings.py
View file

@ -61,7 +61,7 @@ DEFAULT_CONFIG = {
'NEWEST_FIRST_ARCHIVES': True,
'REVERSE_CATEGORY_ORDER': False,
'DELETE_OUTPUT_DIRECTORY': False,
'OUTPUT_RETENTION': (),
'OUTPUT_RETENTION': [],
'ARTICLE_URL': '{slug}.html',
'ARTICLE_SAVE_AS': '{slug}.html',
'ARTICLE_ORDER_BY': 'slug',
@ -97,9 +97,9 @@ DEFAULT_CONFIG = {
'DEFAULT_LANG': 'en',
'TAG_CLOUD_STEPS': 4,
'TAG_CLOUD_MAX_ITEMS': 100,
'DIRECT_TEMPLATES': ('index', 'tags', 'categories', 'authors', 'archives'),
'DIRECT_TEMPLATES': ['index', 'tags', 'categories', 'authors', 'archives'],
'EXTRA_TEMPLATES_PATHS': [],
'PAGINATED_DIRECT_TEMPLATES': ('index', ),
'PAGINATED_DIRECT_TEMPLATES': ['index'],
'PELICAN_CLASS': 'pelican.Pelican',
'DEFAULT_DATE_FORMAT': '%a %d %B %Y',
'DATE_FORMATS': {},
@ -110,7 +110,7 @@ DEFAULT_CONFIG = {
'LOCALE': [''], # defaults to user locale
'DEFAULT_PAGINATION': False,
'DEFAULT_ORPHANS': 0,
'DEFAULT_METADATA': (),
'DEFAULT_METADATA': {},
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2}).*',
'PATH_METADATA': '',
'EXTRA_PATH_METADATA': {},

2
pelican/tests/default_conf.py
View file

@ -26,7 +26,7 @@ SOCIAL = (('twitter', 'http://twitter.com/ametaireau'),
('github', 'http://github.com/ametaireau'),)
# global metadata to all the contents
DEFAULT_METADATA = (('yeah', 'it is'),)
DEFAULT_METADATA = {'yeah': 'it is'}
# path-specific metadata
EXTRA_PATH_METADATA = {

2
samples/pelican.conf.py
View file

@ -32,7 +32,7 @@ SOCIAL = (('twitter', 'http://twitter.com/ametaireau'),
('github', 'http://github.com/ametaireau'),)
# global metadata to all the contents
DEFAULT_METADATA = (('yeah', 'it is'),)
DEFAULT_METADATA = {'yeah': 'it is'}
# path-specific metadata
EXTRA_PATH_METADATA = {

2
samples/pelican.conf_FR.py
View file

@ -36,7 +36,7 @@ SOCIAL = (('twitter', 'http://twitter.com/ametaireau'),
('github', 'http://github.com/ametaireau'),)
# global metadata to all the contents
DEFAULT_METADATA = (('yeah', 'it is'),)
DEFAULT_METADATA = {'yeah': 'it is'}
# path-specific metadata
EXTRA_PATH_METADATA = {