From: Vladimír Vondruš <mosra@centrum.cz>
Date: Thu, 13 Sep 2018 17:49:29 +0000 (+0200)
Subject: doc: fix warnings coming from (the upcoming) Pelican 3.8.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=e29c346a9bbb71f8f7903447b44f9ca22c202924;p=blog.git

doc: fix warnings coming from (the upcoming) Pelican 3.8.
---

diff --git a/doc/examples/authors/an-author.rst b/doc/examples/authors/an-author.rst
index f4ca3ea5..1e45b841 100644
--- a/doc/examples/authors/an-author.rst
+++ b/doc/examples/authors/an-author.rst
@@ -1,3 +1,6 @@
+An Author
+#########
+
 :image: {filename}/static/mosra.jpg
 :badge: Info badge for `An Author <{author}an-author>`_ provided by the
     `Metadata <{filename}/plugins/metadata.rst>`_ plugin.
diff --git a/doc/examples/categories/examples.rst b/doc/examples/categories/examples.rst
index 001503c2..a812bba9 100644
--- a/doc/examples/categories/examples.rst
+++ b/doc/examples/categories/examples.rst
@@ -1,3 +1,6 @@
+Examples
+########
+
 :image: {filename}/static/site.jpg
 :badge: Info badge for the `Examples <{category}examples>`_ category provided
     by the `Metadata <{filename}/plugins/metadata.rst>`_ plugin.
diff --git a/doc/examples/tags/jumbo.rst b/doc/examples/tags/jumbo.rst
index 1ae79084..b88b5dfa 100644
--- a/doc/examples/tags/jumbo.rst
+++ b/doc/examples/tags/jumbo.rst
@@ -1,2 +1,5 @@
+Jumbo
+#####
+
 Detailed tag info provided by the `Metadata <{filename}/plugins/metadata.rst>`_
 plugin.
diff --git a/doc/plugins/metadata.rst b/doc/plugins/metadata.rst
index 1a65e2ee..00f351c1 100644
--- a/doc/plugins/metadata.rst
+++ b/doc/plugins/metadata.rst
@@ -93,7 +93,8 @@ following metadata are recognized:
     block and in ``og:title`` / ``twitter:title`` social :html:`<meta>` tag on
     author page. Can be used to provide a longer version of author name on this
     page. If not set, the m.css Pelican theme uses the global author name (the
-    one set by articles) instead.
+    one set by articles) instead --- but note that since 3.8, Pelican will warn
+    about this and suggest to specify the title explicitly.
 -   The :rst:`:description:` field is exposed to the theme in
     :py:`author.page.description` on the author page. The m.css Pelican theme
     uses it in :html:`<meta name="description">`. If not set, no tag is
@@ -165,7 +166,9 @@ for category named *Guest posts* will be in a file named
     :html:`<meta>` tag on category page and as badge title on article pages.
     Can be used to provide a longer version of category name for article badge
     and detailed category info. If not set, the m.css Pelican theme uses the
-    global category name (the one set by articles) instead.
+    global category name (the one set by articles) instead --- but note that
+    since 3.8, Pelican will warn about this and suggest to specify the title
+    explicitly.
 -   The :rst:`:description:` field is exposed to the theme in
     :py:`category.page.description` on the category page. The m.css Pelican
     theme uses it in :html:`<meta name="description">`. If not set, no tag is
@@ -235,7 +238,9 @@ following metadata are recognized:
     is used as caption in tag details block on tag page and in ``og:title`` /
     ``twitter:title`` social :html:`<meta>` tag. Can be used to provide a
     longer version of tag name on this page. If not set, the m.css Pelican
-    theme uses the global tag name (the one set by articles) instead.
+    theme uses the global tag name (the one set by articles) instead --- but
+    note that since 3.8, Pelican will warn about this and suggest to specify
+    the title explicitly.
 -   The :rst:`:description:` field is exposed to the theme in
     :py:`tag.page.description` on the tag page. The m.css Pelican theme uses
     it in :html:`<meta name="description">`. If not set, no :html:`<meta>` tag