diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index ba5328f4..65573562 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -54,3 +54,6 @@ - Neil Muller Numerous fixes, including those for Python 3 compatibility. +- The IPython team + From whom we borrowed the github+web tools / style. + diff --git a/doc/source/conf.py b/doc/source/conf.py index 7f16ab57..febe1fe1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -103,8 +103,8 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' -#html_style = 'scipy.css' +html_theme = 'agogo' +html_style = 'agogo.css' # 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 @@ -112,7 +112,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ['themes'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/source/themes/agogo/layout.html b/doc/source/themes/agogo/layout.html new file mode 100644 index 00000000..0e18ba22 --- /dev/null +++ b/doc/source/themes/agogo/layout.html @@ -0,0 +1,58 @@ +{# + agogo/layout.html + ~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the agogo theme, originally written + by Andi Albrecht. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{% extends "basic/layout.html" %} + + +{% block header %} +
+
+ {%- block headertitle %} + + {%- if logo %} + + {%- endif %} + {#

{{ shorttitle|e }}

#} + {%- endblock %} +
+
+{% endblock %} + + + +{% block content %} +
+
+ {%- block sidebar2 %} + {# We don't want the logo here #} + {%- block sidebarlogo %} {% endblock %} + {{ sidebar() }} + {% endblock %} +
+ {%- block document %} + {{ super() }} + {%- endblock %} +
+
+
+
+{% endblock %} + +{% block footer %} +
+ {{ super() }} +
+{% endblock %} + +{% block relbar1 %}{% endblock %} + +{% block relbar2 %}{% endblock %} diff --git a/doc/source/themes/agogo/static/agogo.css_t b/doc/source/themes/agogo/static/agogo.css_t new file mode 100644 index 00000000..443e66c8 --- /dev/null +++ b/doc/source/themes/agogo/static/agogo.css_t @@ -0,0 +1,483 @@ +/* + * agogo.css_t + * ~~~~~~~~~~~ + * + * Sphinx stylesheet -- agogo theme. + * + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +* { + margin: 0px; + padding: 0px; +} + + +div.header-wrapper { + border-top: 0px solid #babdb6; + padding: 1em 1em 0; + min-height: 0px; +} + +body { + font-family: {{ theme_bodyfont }}; + line-height: 1.4em; + color: black; + background-color: {{ theme_bgcolor }}; +} + + +/* Page layout */ + +div.header, div.content, div.footer { + max-width: {{ theme_pagewidth }}; + margin-left: auto; + margin-right: auto; +} + +div.header-wrapper { + border-bottom: 0px solid #2e3436; +} + + +/* Default body styles */ +a { + color: {{ theme_linkcolor }}; +} + +div.bodywrapper a, div.footer a { + text-decoration: underline; +} + +.clearer { + clear: both; +} + +.left { + float: left; +} + +.right { + float: right; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +h1, h2, h3, h4 { + font-weight: normal; + color: {{ theme_headercolor2 }}; + margin-bottom: .8em; +} + +h1 { + color: {{ theme_headercolor1 }}; + line-height: 1.1em; + text-align: left; +} + +h2 { + padding-bottom: .5em; + border-bottom: 1px solid {{ theme_headercolor2 }}; +} + +a.headerlink { + visibility: hidden; + color: #dddddd; + padding-left: .3em; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +img { + border: 0; +} + +pre { + background-color: #EEE; + padding: 0.5em; +} + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 2px 7px 1px 7px; + border-left: 0.2em solid black; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +/* Header */ + +div.header {} + +div.header h1 { + font-family: "Trebuchet MS", Helvetica, sans-serif; + font-weight: normal; + font-size: 250%; + letter-spacing: .08em; + line-height: 70px; + margin-bottom: 0; +} + +div.header h1 a { + color: white; +} + +div.header h1 a:hover { + text-decoration: none; +} + +div.header div.rel { + margin-top: 1em; + border-top: 1px solid #AAA; + border-bottom: 1px solid #AAA; + border-radius: 5px; + padding: 3px 1em; +} + +div.header div.rel a { + color: {{ theme_linkcolor }}; + letter-spacing: .05em; + font-weight: bold; +} + +div.logo {} + +img.logo { + border: 0; +} + + +/* Content */ +div.content-wrapper { + background-color: white; + padding: 1em; +} + +div.document { + max-width: {{ theme_documentwidth }}; +} + +div.body { + padding-right: 2em; + text-align: {{ theme_textalign }}; +} + +div.document ul { + margin: 1.5em; + list-style-type: square; +} + +div.document dd { + margin-left: 1.2em; + margin-top: .4em; + margin-bottom: 1em; +} + +div.document .section { + margin-top: 1.7em; +} +div.document .section:first-child { + margin-top: 0px; +} + +div.document div.highlight { + padding: 3px; + background-color: #eeeeec; + border-top: 2px solid #dddddd; + border-bottom: 2px solid #dddddd; + margin-top: .8em; + margin-bottom: .8em; +} + +div.document h2 { + margin-top: .7em; +} + +div.document p { + margin-bottom: .5em; +} + +div.document li.toctree-l1 { + margin-bottom: 1em; +} + +div.document .descname { + font-weight: bold; +} + +div.document .docutils.literal { + background-color: #eeeeec; + padding: 1px; +} + +div.document .docutils.xref.literal { + background-color: transparent; + padding: 0px; +} + +div.document blockquote { + margin: 1em; +} + +div.document ol { + margin: 1.5em; +} + + +/* Sidebar */ + +div.sphinxsidebar { + width: {{ theme_sidebarwidth }}; + padding: 0 1em; + float: right; + font-size: .93em; + background-color: white; +} + +div.sphinxsidebar a, div.header a { + text-decoration: none; +} + +div.sphinxsidebar a:hover, div.header a:hover { + text-decoration: underline; +} + +div.sphinxsidebar h3 { + color: #2e3436; + text-transform: uppercase; + font-size: 130%; + letter-spacing: .1em; + margin-bottom: .4em; +} + +div.sphinxsidebar h4 { + margin-bottom: 0; + font-weight: bold; +} + +div.sphinxsidebar .tile { + border: 1px solid #D1DDE2; + border-radius: 10px; + background-color: #E1E8EC; + padding-left: 0.5em; + margin: 1em 0; +} + +div.sphinxsidebar ul { + list-style-type: none; +} + +div.sphinxsidebar li.toctree-l1 a { + display: block; + padding: 1px; + border: 1px solid #dddddd; + background-color: #eeeeec; + margin-bottom: .4em; + padding-left: 3px; + color: #2e3436; +} + +div.sphinxsidebar li.toctree-l2 a { + background-color: transparent; + border: none; + margin-left: 1em; + border-bottom: 1px solid #dddddd; +} + +div.sphinxsidebar li.toctree-l3 a { + background-color: transparent; + border: none; + margin-left: 2em; + border-bottom: 1px solid #dddddd; +} + +div.sphinxsidebar li.toctree-l2:last-child a { + border-bottom: none; +} + +div.sphinxsidebar li.toctree-l1.current a { + border-right: 5px solid {{ theme_headerlinkcolor }}; +} + +div.sphinxsidebar li.toctree-l1.current li.toctree-l2 a { + border-right: none; +} + +div.sidebarblock { + padding-bottom: .4em; + border-bottom: 1px solid #AAA; + margin-bottom: .8em; +} + + +/* Footer */ + +div.footer-wrapper { + padding-top: 10px; + padding-bottom: 10px; +} + +div.footer { + border-top: 2px solid #aaa; + text-align: right; +} + +div.footer, div.footer a { + color: #888a85; +} + + +/* Styles copied from basic theme */ + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + clear: both; + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +/* -- viewcode extension ---------------------------------------------------- */ + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family:: {{ theme_bodyfont }}; +} + +div.viewcode-block:target { + margin: -1px -3px; + padding: 0 3px; + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} diff --git a/doc/source/themes/agogo/theme.conf b/doc/source/themes/agogo/theme.conf new file mode 100644 index 00000000..3a6e6c60 --- /dev/null +++ b/doc/source/themes/agogo/theme.conf @@ -0,0 +1,18 @@ +[theme] +inherit = basic +stylesheet = agogo.css +pygments_style = tango + +[options] +bodyfont = "Verdana", Arial, sans-serif +pagewidth = 70em +documentwidth = 55em +sidebarwidth = 14em +bgcolor = white +headerbg = url(bgtop.png) top left repeat-x +footerbg = url(bgfooter.png) top left repeat-x +linkcolor = #ce5c00 +headercolor1 = #204a87 +headercolor2 = #3465a4 +headerlinkcolor = #fcaf3e +textalign = justify