Merge remote-tracking branch 'upstream/master'

docs/changelog.rst

@@ -1,6 +1,30 @@
 Release history
 ###############
 
+4.1.3 - 2019-10-09
+==================
+
+* Fix quick-start docs regarding `pelican --listen`
+* Set default listen address to 127.0.0.1
+* Add extra/optional Markdown dependency to setup.py
+* Use correct SSH port syntax for rsync in tasks.py
+* Place all deprecated settings handling together
+* Add related project URLs for display on PyPI
+* Skip some tests on Windows that can't pass due to filesystem differences
+
+4.1.2 - 2019-09-23
+==================
+
+Fix pelican.settings.load_source to avoid caching issues - PR #2621
+
+4.1.1 - 2019-08-23
+==================
+
+* Add AutoPub to auto-publish releases on PR merge
+* Add CSS classes for reStructuredText figures
+* Pass `argv` to Pelican `main` entrypoint
+* Set default content status to a blank string rather than `None`
+
 4.1.0 - 2019-07-14
 ==================
 

docs/install.rst

@@ -9,6 +9,10 @@ You can install Pelican via several different methods. The simplest is via
 
     pip install pelican
 
+Or, if you plan on using Markdown::
+
+    pip install pelican[Markdown]
+
 (Keep in mind that operating systems will often require you to prefix the above
 command with ``sudo`` in order to install Pelican system-wide.)
 
@@ -40,7 +44,11 @@ Optional packages
 -----------------
 
 If you plan on using `Markdown <http://pypi.python.org/pypi/Markdown>`_ as a
-markup format, you'll need to install the Markdown library::
+markup format, you can install Pelican with Markdown support::
+
+   pip install pelican[Markdown]
+
+Or you might need to install it a posteriori::
 
     pip install Markdown
 

docs/publish.rst

@@ -54,20 +54,12 @@ HTML files directly::
     firefox output/index.html
 
 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.
+assets, running Pelican's simple built-in web server will often provide a more
+reliable previewing experience::
 
-For Python 2, run::
+    pelican --listen
 
-    cd output
-    python -m SimpleHTTPServer
-
-For Python 3, run::
-
-    cd output
-    python -m http.server
-
-Once the basic server has been started, you can preview your site at
+Once the web server has been started, you can preview your site at:
 http://localhost:8000/
 
 Deployment

docs/quickstart.rst

@@ -8,10 +8,10 @@ Installation
 ------------
 
 Install Pelican (and optionally Markdown if you intend to use it) on Python
-2.7.x or Python 3.3+ by running the following command in your preferred
+2.7.x or Python 3.5+ by running the following command in your preferred
 terminal, prefixing with ``sudo`` if permissions warrant::
 
-    pip install pelican markdown
+    pip install pelican[Markdown]
 
 Create a project
 ----------------
@@ -50,18 +50,18 @@ Given that this example article is in Markdown format, save it as
 Generate your site
 ------------------
 
-From your site directory, run the ``pelican`` command to generate your site::
+From your project root directory, run the ``pelican`` command to generate your site::
 
     pelican content
 
-Your site has now been generated inside the ``output`` directory. (You may see
+Your site has now been generated inside the ``output/`` directory. (You may see
 a warning related to feeds, but that is normal when developing locally and can
 be ignored for now.)
 
 Preview your site
 -----------------
 
-Open a new terminal session, navigate to your generated output directory and
+Open a new terminal session, navigate to your project root directory, and
 run the following command to launch Pelican's web server::
 
     pelican --listen

docs/settings.rst

@@ -991,7 +991,7 @@ By default, pages subsequent to ``.../foo.html`` are created as
 ``.../foo2.html``, etc. The ``PAGINATION_PATTERNS`` setting can be used to
 change this. It takes a sequence of triples, where each triple consists of::
 
-  (minimum_page, page_url, page_save_as,)
+    (minimum_page, page_url, page_save_as,)
 
 For ``page_url`` and ``page_save_as``, you may use a number of variables.
 ``{url}`` and ``{save_as}`` correspond respectively to the ``*_URL`` and
@@ -1005,7 +1005,7 @@ subsequent pages at ``.../page/2/`` etc, you could set ``PAGINATION_PATTERNS``
 as follows::
 
   PAGINATION_PATTERNS = (
-      (1, '{url}', '{save_as}`,
+      (1, '{url}', '{save_as}',
       (2, '{base_name}/page/{number}/', '{base_name}/page/{number}/index.html'),
   )
 

docs/themes.rst

@@ -75,7 +75,7 @@ output_file     The name of the file currently being generated. For
 articles        The list of articles, ordered descending by date.
                 All the elements are `Article` objects, so you can
                 access their attributes (e.g. title, summary, author
-                etc.). Sometimes this is shadowed (for instance in
+                etc.). Sometimes this is shadowed (for instance, in
                 the tags page). You will then find info about it
                 in the `all_articles` variable.
 dates           The same list of articles, but ordered by date,