From 550ffe4599a856bb1c49e9116b364bb281577c00 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Sat, 3 Dec 2016 14:53:26 -0800 Subject: [PATCH] Remove spurious whitespace in documentation source --- docs/faq.rst | 6 +++--- docs/publish.rst | 2 +- docs/settings.rst | 54 +++++++++++++++++++++++------------------------ 3 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index f75e4e6c..efb49f66 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -138,7 +138,7 @@ your home page. The following Markdown example could be stored in ``content/pages/home.md``:: Title: Welcome to My Site - URL: + URL: save_as: index.html 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 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 ============================================================================== @@ -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. 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 -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:: TAGS_SAVE_AS = '' diff --git a/docs/publish.rst b/docs/publish.rst index 90d91b00..303797c9 100644 --- a/docs/publish.rst +++ b/docs/publish.rst @@ -50,7 +50,7 @@ HTML files directly:: 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 -reliable previewing experience. +reliable previewing experience. For Python 2, run:: diff --git a/docs/settings.rst b/docs/settings.rst index 56608621..aef9f674 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -129,10 +129,10 @@ Basic settings .. data:: MARKDOWN = {...} - Extra configuration settings for the Markdown processor. Refer to the Python - Markdown documentation's `Options section - `_ for a complete - list of supported options. The ``extensions`` option will be automatically + Extra configuration settings for the Markdown processor. Refer to the Python + Markdown documentation's `Options section + `_ for a complete + list of supported options. The ``extensions`` option will be automatically computed from the ``extension_configs`` option. Defaults to:: @@ -147,7 +147,7 @@ Basic settings } .. Note:: - The dictionary defined in your settings file will update this default + The dictionary defined in your settings file will update this default one. .. data:: OUTPUT_PATH = 'output/' @@ -356,10 +356,10 @@ Example usage:: PAGE_URL = 'pages/{slug}/' 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``, 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. .. 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 a page name. -``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the -``_SAVE_AS`` settings are available, but it is available for any direct +``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the +``_SAVE_AS`` settings are available, but it is available for any direct template. .. 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. - 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 + 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 not UTC. 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 ``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. - In addition to the standard C89 strftime format codes that are listed in - `Python strftime documentation`_, you can use the ``-`` character between - ``%`` 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 + In addition to the standard C89 strftime format codes that are listed in + `Python strftime documentation`_, you can use the ``-`` character between + ``%`` 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 in ``1/1/2014``. .. parsed-literal:: @@ -616,8 +616,8 @@ Time and Date 'jp': '%Y-%m-%d(%a)', } - 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 + 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 the ``LOCALE`` setting: .. parsed-literal:: @@ -636,8 +636,8 @@ Time and Date .. data:: LOCALE - 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 + 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 be tried until one works. You can set locale to further control date format: @@ -648,7 +648,7 @@ Time and Date '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 `locale(1)`_ for more information. @@ -672,8 +672,8 @@ Template pages A mapping containing template pages that will be rendered with the blog entries. See :ref:`template_pages`. - 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 + 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 destination path for the generated file. 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')] .. Warning:: - Silencing messages by templates is a dangerous feature. It is possible to - unintentionally filter out multiple message types with the same template + Silencing messages by templates is a dangerous feature. It is possible to + unintentionally filter out multiple message types with the same template (including messages from future Pelican versions). Proceed with caution. .. 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 different versions of Python as the pickle format often changes. If -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 +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 after the ``GZIP_CACHE`` setting has been changed. The ``--ignore-cache`` command-line option is useful when the