summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-06 14:59:11 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-11-06 14:59:11 (GMT)
commit7e58ad7f6565d2997ac6b742519d1a51fb74928f (patch)
treec39c37b0b042919feb9c53ee97f1a640c4749245
parent18985f6c2926725b08f5941205fe21c344c4b3ea (diff)
parenta023a26cada4005fd57e5da9d9c132650594c594 (diff)
downloadCMake-7e58ad7f6565d2997ac6b742519d1a51fb74928f.zip
CMake-7e58ad7f6565d2997ac6b742519d1a51fb74928f.tar.gz
CMake-7e58ad7f6565d2997ac6b742519d1a51fb74928f.tar.bz2
Merge topic 'doc-html-page-layout'
a023a26 Help: Configure html favicon fb33219 Help: Configure html page navigation bars e1f8196 Help: Configure |version| replacement correctly edc7cc9 Help: Configure copyright year automatically
-rw-r--r--Utilities/Sphinx/CMakeLists.txt3
-rw-r--r--Utilities/Sphinx/conf.py.in10
-rw-r--r--Utilities/Sphinx/static/cmake-favicon.icobin0 -> 1150 bytes
-rw-r--r--Utilities/Sphinx/static/cmake-logo-16.pngbin0 -> 761 bytes
-rw-r--r--Utilities/Sphinx/templates/layout.html13
5 files changed, 22 insertions, 4 deletions
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt
index 35c62fb..3b0b335 100644
--- a/Utilities/Sphinx/CMakeLists.txt
+++ b/Utilities/Sphinx/CMakeLists.txt
@@ -38,8 +38,7 @@ endif()
set(conf_docs "${CMake_SOURCE_DIR}/Help")
set(conf_path "${CMAKE_CURRENT_SOURCE_DIR}")
-set(conf_copyright "2000-2013 Kitware, Inc.")
-set(conf_version "${CMake_MAJOR_VERSION}.${CMake_MINOR_VERSION}.${CMake_PATCH_VERSION}")
+set(conf_version "${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}")
set(conf_release "${CMake_VERSION}")
configure_file(conf.py.in conf.py @ONLY)
diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in
index ea00b78..52f4a31 100644
--- a/Utilities/Sphinx/conf.py.in
+++ b/Utilities/Sphinx/conf.py.in
@@ -13,14 +13,15 @@ import sys
import os
import re
import glob
+import time
sys.path.insert(0, r'@conf_path@')
source_suffix = '.rst'
master_doc = 'index'
-project = 'CMake'
-copyright = '@conf_copyright@'
+project = 'CMake'
+copyright = '2000-%s Kitware, Inc.' % time.strftime('%Y')
version = '@conf_version@' # feature version
release = '@conf_release@' # full version string
@@ -29,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:(.*)$')
@@ -56,3 +58,7 @@ 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
+html_favicon = 'cmake-favicon.ico'
diff --git a/Utilities/Sphinx/static/cmake-favicon.ico b/Utilities/Sphinx/static/cmake-favicon.ico
new file mode 100644
index 0000000..fce8f92
--- /dev/null
+++ b/Utilities/Sphinx/static/cmake-favicon.ico
Binary files differ
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 %}