chiark / gitweb /
doc: fix warnings coming from (the upcoming) Pelican 3.8.
authorVladimír Vondruš <mosra@centrum.cz>
Thu, 13 Sep 2018 17:49:29 +0000 (19:49 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Thu, 13 Sep 2018 17:49:29 +0000 (19:49 +0200)
doc/examples/authors/an-author.rst
doc/examples/categories/examples.rst
doc/examples/tags/jumbo.rst
doc/plugins/metadata.rst

index f4ca3ea5ea4f1a1c3d039904cd7e8b4016fc787e..1e45b8416bc7ca4f5f198214db1af6411f3acebc 100644 (file)
@@ -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.
index 001503c2d909652570a9b335d10c9e75e4d6b88e..a812bba9d3eae6db911417e9b822c6cdb9f8377f 100644 (file)
@@ -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.
index 1ae79084f0643b28fc5f7cc3742a461c25094a60..b88b5dfadce249e6cd2e4070ad64cbf859991316 100644 (file)
@@ -1,2 +1,5 @@
+Jumbo
+#####
+
 Detailed tag info provided by the `Metadata <{filename}/plugins/metadata.rst>`_
 plugin.
index 1a65e2eedf3e0d235f06d7fc52ccdab44c3e1157..00f351c1d45c32893a0f65427fcc52d105007dc9 100644 (file)
@@ -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