summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakayuki SHIMIZUKAWA <shimizukawa@gmail.com>2015-12-09 16:54:45 +0900
committerTakayuki SHIMIZUKAWA <shimizukawa@gmail.com>2015-12-09 16:54:45 +0900
commit8bfc9409ec7a6d32fd10a1961e716da3081205a1 (patch)
tree24487e21f50b19666457e36704892c2c1c954554
parent3d4a11ecd6026e28967ceed92c2ab62891ba6b6f (diff)
parent2c58eef1d1f77e1bd44ba38f039c8fc80d7aecb7 (diff)
downloadsphinx-git-8bfc9409ec7a6d32fd10a1961e716da3081205a1.tar.gz
Merge pull request #1757 from hemmecke/master
fix unclear documentation for html_last_updated_fmt
-rw-r--r--doc/config.rst7
-rw-r--r--sphinx/quickstart.py7
2 files changed, 8 insertions, 6 deletions
diff --git a/doc/config.rst b/doc/config.rst
index f3ebd7f6f..29469bb86 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -637,9 +637,10 @@ that use Sphinx's HTMLWriter class.
.. confval:: html_last_updated_fmt
- If this is not the empty string, a 'Last updated on:' timestamp is inserted
- at every page bottom, using the given :func:`strftime` format. Default is
- ``'%b %d, %Y'`` (or a locale-dependent equivalent).
+ If this is not None, a 'Last updated on:' timestamp is inserted
+ at every page bottom, using the given :func:`strftime` format.
+ The empty string is equivalent to '%b %d, %Y' (or a
+ locale-dependent equivalent).
.. confval:: html_use_smartypants
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index 1cfe715c5..ffc4961dc 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -216,9 +216,10 @@ html_static_path = ['%(dot)sstatic']
# directly to the root of the documentation.
#html_extra_path = []
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%%b %%d, %%Y'
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%%b %%d, %%Y'.
+#html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.