summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorMarkus Amalthea Magnuson <markus.magnuson@gmail.com>2013-09-29 10:52:45 +0200
committerTim Graham <timograham@gmail.com>2014-02-10 08:24:40 -0500
commit59d9b264745bb1a4736bb6df4dafb83049835483 (patch)
treea0609ab18deb6a4d5d7ac48f9096c564d0bf4b8c /docs/conf.py
parent9a4ee8ddb858ae07ff42be0261c867aa3d2eb53c (diff)
Fixed #21190 -- Added a new ePub theme for documentation.
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py34
1 files changed, 32 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 6bc293d02a..ff919a6265 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -273,10 +273,19 @@ texinfo_documents = [(
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
-epub_title = 'Django'
+epub_title = project
epub_author = 'Django Software Foundation'
epub_publisher = 'Django Software Foundation'
-epub_copyright = '2010, Django Software Foundation'
+epub_copyright = copyright
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = 'Django'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+epub_theme = 'djangodocs-epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
@@ -292,6 +301,12 @@ epub_copyright = '2010, Django Software Foundation'
# A unique identification for the text.
#epub_uid = ''
+# A tuple containing the cover image and cover page html template filenames.
+epub_cover = ('', 'epub-cover.html')
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
@@ -308,3 +323,18 @@ epub_copyright = '2010, Django Software Foundation'
# Allow duplicate toc entries.
#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True