weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Remove spurious whitespace in documentation source

Browse source
This commit is contained in:
Justin Mayer 2016-12-03 14:53:26 -08:00
commit 550ffe4599
3 changed files with 31 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/faq.rst
View file

@ -138,7 +138,7 @@ your home page. The following Markdown example could be stored in
``content/pages/home.md``:: ``content/pages/home.md``::
Title: Welcome to My Site Title: Welcome to My Site
URL: URL:
save_as: index.html save_as: index.html
Thank you for visiting. Welcome! Thank you for visiting. Welcome!
@ -161,7 +161,7 @@ disable all feed generation, you only need to specify the following settings::
AUTHOR_FEED_RSS = None AUTHOR_FEED_RSS = None
The word ``None`` should not be surrounded by quotes. Please note that ``None`` The word ``None`` should not be surrounded by quotes. Please note that ``None``
and ``''`` are not the same thing. and ``''`` are not the same thing.
I'm getting a warning about feeds generated without SITEURL being set properly I'm getting a warning about feeds generated without SITEURL being set properly
============================================================================== ==============================================================================
@ -203,7 +203,7 @@ Is Pelican only suitable for blogs?
No. Pelican can be easily configured to create and maintain any type of static site. No. Pelican can be easily configured to create and maintain any type of static site.
This may require a little customization of your theme and Pelican configuration. This may require a little customization of your theme and Pelican configuration.
For example, if you are building a launch site for your product and do not need For example, if you are building a launch site for your product and do not need
tags on your site, you could remove the relevant HTML code from your theme. tags on your site, you could remove the relevant HTML code from your theme.
You can also disable generation of tag-related pages via:: You can also disable generation of tag-related pages via::
TAGS_SAVE_AS = '' TAGS_SAVE_AS = ''

2
docs/publish.rst
View file

@ -50,7 +50,7 @@ HTML files directly::
Because the above method may have trouble locating your CSS and other linked Because the above method may have trouble locating your CSS and other linked
assets, running a simple web server using Python will often provide a more assets, running a simple web server using Python will often provide a more
reliable previewing experience. reliable previewing experience.
For Python 2, run:: For Python 2, run::

54
docs/settings.rst
View file

@ -129,10 +129,10 @@ Basic settings
.. data:: MARKDOWN = {...} .. data:: MARKDOWN = {...}
Extra configuration settings for the Markdown processor. Refer to the Python Extra configuration settings for the Markdown processor. Refer to the Python
Markdown documentation's `Options section Markdown documentation's `Options section
<http://pythonhosted.org/Markdown/reference.html#markdown>`_ for a complete <http://pythonhosted.org/Markdown/reference.html#markdown>`_ for a complete
list of supported options. The ``extensions`` option will be automatically list of supported options. The ``extensions`` option will be automatically
computed from the ``extension_configs`` option. computed from the ``extension_configs`` option.
Defaults to:: Defaults to::
@ -147,7 +147,7 @@ Basic settings
} }
.. Note:: .. Note::
The dictionary defined in your settings file will update this default The dictionary defined in your settings file will update this default
one. one.
.. data:: OUTPUT_PATH = 'output/' .. data:: OUTPUT_PATH = 'output/'
@ -356,10 +356,10 @@ Example usage::
PAGE_URL = 'pages/{slug}/' PAGE_URL = 'pages/{slug}/'
PAGE_SAVE_AS = 'pages/{slug}/index.html' PAGE_SAVE_AS = 'pages/{slug}/index.html'
This would save your articles into something like This would save your articles into something like
``/posts/2011/Aug/07/sample-post/index.html``, ``/posts/2011/Aug/07/sample-post/index.html``,
save your pages into ``/pages/about/index.html``, and render them available at save your pages into ``/pages/about/index.html``, and render them available at
URLs of ``/posts/2011/Aug/07/sample-post/`` and ``/pages/about/``, URLs of ``/posts/2011/Aug/07/sample-post/`` and ``/pages/about/``,
respectively. respectively.
.. data:: RELATIVE_URLS = False .. data:: RELATIVE_URLS = False
@ -523,8 +523,8 @@ posts for the month at ``posts/2011/Aug/index.html``.
arrive at an appropriate archive of posts, without having to specify arrive at an appropriate archive of posts, without having to specify
a page name. a page name.
``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the ``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the
``_SAVE_AS`` settings are available, but it is available for any direct ``_SAVE_AS`` settings are available, but it is available for any direct
template. template.
.. data:: ARCHIVES_SAVE_AS = 'archives.html' .. data:: ARCHIVES_SAVE_AS = 'archives.html'
@ -570,8 +570,8 @@ Time and Date
The timezone used in the date information, to generate Atom and RSS feeds. The timezone used in the date information, to generate Atom and RSS feeds.
If no timezone is defined, UTC is assumed. This means that the generated If no timezone is defined, UTC is assumed. This means that the generated
Atom and RSS feeds will contain incorrect date information if your locale is Atom and RSS feeds will contain incorrect date information if your locale is
not UTC. not UTC.
Pelican issues a warning in case this setting is not defined, as it was not Pelican issues a warning in case this setting is not defined, as it was not
@ -600,13 +600,13 @@ Time and Date
If no ``DATE_FORMATS`` are set, Pelican will fall back to If no ``DATE_FORMATS`` are set, Pelican will fall back to
``DEFAULT_DATE_FORMAT``. If you need to maintain multiple languages with ``DEFAULT_DATE_FORMAT``. If you need to maintain multiple languages with
different date formats, you can set the ``DATE_FORMATS`` dictionary using different date formats, you can set the ``DATE_FORMATS`` dictionary using
the language name (``lang`` metadata in your post content) as the key. the language name (``lang`` metadata in your post content) as the key.
In addition to the standard C89 strftime format codes that are listed in In addition to the standard C89 strftime format codes that are listed in
`Python strftime documentation`_, you can use the ``-`` character between `Python strftime documentation`_, you can use the ``-`` character between
``%`` and the format character to remove any leading zeros. For example, ``%`` and the format character to remove any leading zeros. For example,
``%d/%m/%Y`` will output ``01/01/2014`` whereas ``%-d/%-m/%Y`` will result ``%d/%m/%Y`` will output ``01/01/2014`` whereas ``%-d/%-m/%Y`` will result
in ``1/1/2014``. in ``1/1/2014``.
.. parsed-literal:: .. parsed-literal::
@ -616,8 +616,8 @@ Time and Date
'jp': '%Y-%m-%d(%a)', 'jp': '%Y-%m-%d(%a)',
} }
It is also possible to set different locale settings for each language by It is also possible to set different locale settings for each language by
using a ``(locale, format)`` tuple as a dictionary value which will override using a ``(locale, format)`` tuple as a dictionary value which will override
the ``LOCALE`` setting: the ``LOCALE`` setting:
.. parsed-literal:: .. parsed-literal::
@ -636,8 +636,8 @@ Time and Date
.. data:: LOCALE .. data:: LOCALE
Change the locale [#]_. A list of locales can be provided here or a single Change the locale [#]_. A list of locales can be provided here or a single
string representing one locale. When providing a list, all the locales will string representing one locale. When providing a list, all the locales will
be tried until one works. be tried until one works.
You can set locale to further control date format: You can set locale to further control date format:
@ -648,7 +648,7 @@ Time and Date
'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
`locale(1)`_ for more information. `locale(1)`_ for more information.
@ -672,8 +672,8 @@ Template pages
A mapping containing template pages that will be rendered with the blog A mapping containing template pages that will be rendered with the blog
entries. See :ref:`template_pages`. entries. See :ref:`template_pages`.
If you want to generate custom pages besides your blog entries, you can If you want to generate custom pages besides your blog entries, you can
point any Jinja2 template file with a path pointing to the file and the point any Jinja2 template file with a path pointing to the file and the
destination path for the generated file. destination path for the generated file.
For instance, if you have a blog with three static pages — a list of books, For instance, if you have a blog with three static pages — a list of books,
@ -1125,8 +1125,8 @@ For example::
[(logging.WARN, 'Empty alt attribute for image %s in %s')] [(logging.WARN, 'Empty alt attribute for image %s in %s')]
.. Warning:: .. Warning::
Silencing messages by templates is a dangerous feature. It is possible to Silencing messages by templates is a dangerous feature. It is possible to
unintentionally filter out multiple message types with the same template unintentionally filter out multiple message types with the same template
(including messages from future Pelican versions). Proceed with caution. (including messages from future Pelican versions). Proceed with caution.
.. note:: .. note::
@ -1182,8 +1182,8 @@ can be invoked by passing the ``--archive`` flag).
The cache files are Python pickles, so they may not be readable by The cache files are Python pickles, so they may not be readable by
different versions of Python as the pickle format often changes. If different versions of Python as the pickle format often changes. If
such an error is encountered, it is caught and the cache file is such an error is encountered, it is caught and the cache file is
rebuilt automatically in the new format. The cache files will also be rebuilt automatically in the new format. The cache files will also be
rebuilt after the ``GZIP_CACHE`` setting has been changed. rebuilt after the ``GZIP_CACHE`` setting has been changed.
The ``--ignore-cache`` command-line option is useful when the The ``--ignore-cache`` command-line option is useful when the