Skip to content

Commit

Permalink
Merge pull request #1593 from iKevinY/clarify-setting-types
Browse files Browse the repository at this point in the history 
Change the documented type of various settings
  • Loading branch information
@justinmayer
justinmayer committed Feb 17, 2015
2 parents 6c4f0d7 + 88ad46f commit ca0477c
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/content.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ via the ``keywords`` metadata, as is standard in HTML. The two can be used
interchangeably.

Note that, aside from the title, none of this article metadata is mandatory:
if the date is not specified and ``DEFAULT_DATE`` is set to ``fs``, Pelican
if the date is not specified and ``DEFAULT_DATE`` is set to ``'fs'``, Pelican
will rely on the file's "mtime" timestamp, and the category can be determined
by the directory in which the file resides. For example, a file located at
``python/foobar/myfoobar.rst`` will have a category of ``foobar``. If you would
Expand Down
25 changes: 12 additions & 13 deletions docs/settings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,17 @@ Setting name (followed by default value, if any)
template. Templates may or not honor this
setting.
``DEFAULT_DATE = None`` The default date you want to use.
If ``fs``, Pelican will use the file system
If ``'fs'``, Pelican will use the file system
timestamp information (mtime) if it can't get
date information from the metadata.
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
(applicable only to reStructuredText). See `Docutils
Configuration`_ settings for more details.

``FILENAME_METADATA =`` ``'(?P<date>\d{4}-\d{2}-\d{2}).*'`` The regexp that will be used to extract any metadata
from the filename. All named groups that are matched
will be set in the metadata object.
Expand All @@ -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`_.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -394,7 +393,7 @@ Date format and locale
If no ``DATE_FORMATS`` are set, Pelican will fall back to
``DEFAULT_DATE_FORMAT``. If you need to maintain multiple languages with
different date formats, you can set the ``DATE_FORMATS`` dictionary using the
language name (``lang`` metadata in your post content) as the key.
language name (``lang`` metadata in your post content) as the key.

In addition to the standard C89 strftime format codes that are listed in
`Python strftime documentation`_, you can use ``-`` character between ``%`` and
Expand Down
8 changes: 4 additions & 4 deletions pelican/settings.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
'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',
Expand Down Expand Up @@ -94,9 +94,9 @@
'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': {},
Expand All @@ -107,7 +107,7 @@
'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': {},
Expand Down
2 changes: 1 addition & 1 deletion pelican/tests/default_conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
('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 = {
Expand Down
2 changes: 1 addition & 1 deletion samples/pelican.conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
('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 = {
Expand Down
2 changes: 1 addition & 1 deletion samples/pelican.conf_FR.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
('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 = {
Expand Down

0 comments on commit ca0477c

Please sign in to comment.