summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorWAKAYAMA Shirou <shirou.faw@gmail.com>2013-02-09 23:01:42 +0900
committerWAKAYAMA Shirou <shirou.faw@gmail.com>2013-02-09 23:01:42 +0900
commit16d1e3ef3e977ffeb9a2bf403862ebce6cff4c61 (patch)
tree3f8318f18602bc8a35b86b67ad09d236ad07afa9 /doc/config.rst
parentf36edd3880a302d840191be9d572c56d599da85f (diff)
downloadsphinx-16d1e3ef3e977ffeb9a2bf403862ebce6cff4c61.tar.gz
change "epub_show_urls" option default value to 'inline'.
This keeps the current behaviour.
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 92a8549b..1f2a2fa8 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -939,11 +939,12 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
.. confval:: epub_show_urls
- Control whether to display URL addresses. This is very useful for printed
- copies of the manual. The setting can have the following values:
+ Control whether to display URL addresses. This is very useful for
+ readers that have no other means to display the linked URL. The
+ settings can have the following values:
- * ``'no'`` -- do not display URLs (default)
- * ``'inline'`` -- display URLs inline in parentheses
+ * ``'inline'`` -- display URLs inline in parentheses (default)
+ * ``'no'`` -- do not display URLs
.. _latex-options: