summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-04 19:17:43 (GMT)
committerBrad King <brad.king@kitware.com>2013-11-05 13:58:56 (GMT)
commitfb332197bfabe5eb3b8dbd83d3d5c0d9032d71ca (patch)
treee13805d845adf1986f8df7523f3c95aa47494303 /Utilities/Sphinx
parente1f819664b7d2c2a26342a2d277e95f194ed71d7 (diff)
downloadCMake-fb332197bfabe5eb3b8dbd83d3d5c0d9032d71ca.zip
CMake-fb332197bfabe5eb3b8dbd83d3d5c0d9032d71ca.tar.gz
CMake-fb332197bfabe5eb3b8dbd83d3d5c0d9032d71ca.tar.bz2
Help: Configure html page navigation bars
Add a small CMake logo to the left side of the header and footer navigation bars. Set the html theme, title, and short title explicitly.
Diffstat (limited to 'Utilities/Sphinx')
-rw-r--r--Utilities/Sphinx/conf.py.in4
-rw-r--r--Utilities/Sphinx/static/cmake-logo-16.pngbin0 -> 761 bytes
-rw-r--r--Utilities/Sphinx/templates/layout.html13
3 files changed, 17 insertions, 0 deletions
diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in
index d8daee4..e8f5d8a 100644
--- a/Utilities/Sphinx/conf.py.in
+++ b/Utilities/Sphinx/conf.py.in
@@ -30,6 +30,7 @@ primary_domain = 'cmake'
exclude_patterns = []
extensions = ['cmake']
+templates_path = ['@conf_path@/templates']
cmake_manuals = sorted(glob.glob(r'@conf_docs@/manual/*.rst'))
cmake_manual_description = re.compile('^\.\. cmake-manual-description:(.*)$')
@@ -57,3 +58,6 @@ man_show_urls = False
html_show_sourcelink = True
html_static_path = ['@conf_path@/static']
html_style = 'cmake.css'
+html_theme = 'default'
+html_title = 'CMake %s Documentation' % release
+html_short_title = '%s Documentation' % release
diff --git a/Utilities/Sphinx/static/cmake-logo-16.png b/Utilities/Sphinx/static/cmake-logo-16.png
new file mode 100644
index 0000000..2039c25
--- /dev/null
+++ b/Utilities/Sphinx/static/cmake-logo-16.png
Binary files differ
diff --git a/Utilities/Sphinx/templates/layout.html b/Utilities/Sphinx/templates/layout.html
new file mode 100644
index 0000000..635ace3
--- /dev/null
+++ b/Utilities/Sphinx/templates/layout.html
@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+ <li>
+ <img src="{{ pathto('_static/cmake-logo-16.png', 1) }}" alt=""
+ style="vertical-align: middle; margin-top: -2px" />
+ </li>
+ <li>
+ <a href="http://www.cmake.org/">CMake</a>{{ reldelim1 }}
+ </li>
+ <li>
+ <a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}
+ </li>
+{% endblock %}