From: Georg Brandl <georg@python.org>
Date: Sun, 27 Apr 2008 20:03:05 +0000 (+0000)
Subject: Add OpenSearch and a Python logo to the HTML output.
X-Git-Tag: v2.6a3~88
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4f1f36bcabe098394934ac7cac84c1f26fff2c86;p=python

Add OpenSearch and a Python logo to the HTML output.
---

diff --git a/Doc/conf.py b/Doc/conf.py
index 45d40fbd43..e4641ea1bb 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -85,6 +85,12 @@ html_additional_pages = {
     'index': 'indexcontent.html',
 }
 
+# Output an OpenSearch description file.
+html_use_opensearch = True
+
+# Additional static files.
+html_static_path = ['tools/sphinxext/static']
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'python' + release.replace('.', '')
 
diff --git a/Doc/tools/sphinxext/layout.html b/Doc/tools/sphinxext/layout.html
new file mode 100644
index 0000000000..689cbdace0
--- /dev/null
+++ b/Doc/tools/sphinxext/layout.html
@@ -0,0 +1,5 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+<li><img src="{{ pathto('_static/py.png', 1) }}" alt="" style="vertical-align: middle; margin-top: -1px"/></li>
+{{ super() }}
+{% endblock %}
diff --git a/Doc/tools/sphinxext/opensearch.xml b/Doc/tools/sphinxext/opensearch.xml
new file mode 100644
index 0000000000..d672c2e2b8
--- /dev/null
+++ b/Doc/tools/sphinxext/opensearch.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>Python Docs</ShortName>
+  <LongName>Python Documentation</LongName>
+  <Description>Search the Python documentation</Description>
+  <InputEncoding>utf-8</InputEncoding>
+  <Url type="text/html" method="get" template="{{ pathto('search') }}?">
+    <Param name="q" value="{searchTerms}" />
+    <Param name="check_keywords" value="yes" />
+    <Param name="area" value="default" />
+  </Url>
+  <Image height="16" width="16" type="image/x-icon">http://www.python.org/images/favicon16x16.ico</Image>
+</OpenSearchDescription>
+
diff --git a/Doc/tools/sphinxext/static/py.png b/Doc/tools/sphinxext/static/py.png
new file mode 100644
index 0000000000..93e4a02c3d
Binary files /dev/null and b/Doc/tools/sphinxext/static/py.png differ