From 7236ee4f4fe6ec48d9d9e7a2cf0f22a7e2ee1119 Mon Sep 17 00:00:00 2001 From: Zhanna Tsitkov Date: Wed, 25 Apr 2012 19:10:41 +0000 Subject: [PATCH] Use "agogo" HTML theme (with some modifications) for the Sphinx documentation. Do not show the ReST source files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25823 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/rst_source/_static/kerb.css | 62 +++++++++++++++++++++++++++ doc/rst_source/_templates/layout.html | 49 +++++++++++++++++++-- doc/rst_source/conf.py | 10 ++--- 3 files changed, 112 insertions(+), 9 deletions(-) create mode 100644 doc/rst_source/_static/kerb.css diff --git a/doc/rst_source/_static/kerb.css b/doc/rst_source/_static/kerb.css new file mode 100644 index 000000000..93c1340fe --- /dev/null +++ b/doc/rst_source/_static/kerb.css @@ -0,0 +1,62 @@ +/* + * kerb.css + * ~~~~~~~~~~~ + * + * Sphinx stylesheet -- modification to agogo theme. + * + */ +div.body { + padding-right: 2em; + text-align: left; +} + +/* Page layout */ + +div.header-wrapper { + background: #59121e; + border-bottom: 3px solid #2e3436; + border-top: 3px solid #2e3436; +} + +/* Header */ + +div.header div.right a { + color: #fcaf3e; + letter-spacing: .1em; + text-transform: lowercase; + float: right; +} + +/* Content */ + +div.document div.section h1 { + margin-bottom: 20px; + padding: 1px; + line-height: 130%; +} + +div.document div.section dl { + margin-top: 15px; + margin-bottom: 5px; + padding: 1px; + text-align: left; +} + +/* Sidebar */ + +div.sidebar ul { + list-style-type: none; + padding: 1px; + margin-left: 1em; +} + +div.sidebar li.toctree-l3.current a { + border-right: 5px solid #fcaf3e; + font-weight: bold; +} + +/* Other body styles */ + +dt:target, .highlighted { + background-color: #c1c1c1; +} diff --git a/doc/rst_source/_templates/layout.html b/doc/rst_source/_templates/layout.html index 6abea67dd..e0a6adec1 100644 --- a/doc/rst_source/_templates/layout.html +++ b/doc/rst_source/_templates/layout.html @@ -1,8 +1,49 @@ {% extends "!layout.html" %} +{% set rellinks = rellinks + + [('index', 'Full Table of Contents', 'C', 'Contents')] + + [('search', 'Enter search criteria', 'C', 'Search')] %} +{% set css_files = css_files + ["_static/kerb.css"] %} -{% block relbaritems %} -
  • - feedback {{reldelim2}} -
  • +{% block relbar1 %} +
    +
    + +
    +
    +
    {% endblock %} +{%- block content %} +
    +
    + {%- block sidebar1 %} + + {%- endblock %} +
    + {%- block document %} + {{ super() }} + {%- endblock %} +
    +
    +
    +
    +{% endblock %} diff --git a/doc/rst_source/conf.py b/doc/rst_source/conf.py index 89d22e3c9..45d6d546e 100644 --- a/doc/rst_source/conf.py +++ b/doc/rst_source/conf.py @@ -42,7 +42,7 @@ master_doc = 'index' # General information about the project. project = u'MIT Kerberos' -copyright = u'2011, MIT' +copyright = u'2012, MIT' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -93,19 +93,19 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'default' -html_theme = 'sphinxdoc' +html_theme = 'agogo' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { "headerbg": "#59121e", "linkcolor": "#a63019", "footerbg": "#59121e", "bgcolor": "#59121e" } # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = "MIT Kerberos Documentation" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -149,7 +149,7 @@ html_use_smartypants = True html_split_index = True # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True -- 2.26.2