Commit bacc2776 authored by Kelvin Rodriguez's avatar Kelvin Rodriguez Committed by GitHub
Browse files

Merge pull request #9 from jlaura/master 

Updates for documentation
parents bb0a6deb b7e11dbb

docs/_theme/scipy/layout.html

0 → 100644
+268 −0
Original line number Diff line number Diff line 
{#

    scipy/layout.html

    ~~~~~~~~~~~~~~~~~



    Master layout template for Sphinx themes.



    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.

    :license: BSD, see LICENSE for details.

#}

{%- block doctype -%}

<!DOCTYPE html>

{%- endblock %}

{%- set url_root = pathto('', 1) %}

{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}

{%- if not embedded and docstitle %}

  {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}

{%- else %}

  {%- set titlesuffix = "" %}

{%- endif %}



{%- macro relbar_top() %}

    <ul class="nav nav-pills pull-left">

        {%- for link in theme_rootlinks %}

        <li class="active"><a href="{{ link[0] }}">{{ link[1] }}</a></li>

        {%- endfor %}

        {%- block rootrellink %}

	{% if pagename != master_doc %}

        <li class="active"><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a></li>

	{% endif %}

        {%- endblock %}

        {%- for parent in parents %}

          <li class="active"><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a></li>

        {%- endfor %}

        {%- block relbaritems %} {% endblock %}

    </ul>

{%- endmacro %}



{%- macro relbar_top_right() %}

    <ul class="nav nav-pills pull-right">

      {%- for rellink in rellinks %}

      <li class="active">

        <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"

           {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>

      </li>

      {%- endfor %}

    </ul>

{%- endmacro %}



{%- macro relbar_bottom() %}

{%- endmacro %}



{%- macro sidebar() %}

      <div class="spc-rightsidebar span3">

        <div class="sphinxsidebarwrapper">

          {%- block sidebarlogo %}

          {%- if logo %}

            <p class="logo"><a href="{{ pathto(master_doc) }}">

              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo">

            </a></p>

          {%- endif %}

          {%- endblock %}

          {%- if sidebars != None %}

            {#- new style sidebar: explicitly include/exclude templates #}

            {%- for sidebartemplate in sidebars %}

            {%- include sidebartemplate %}

            {%- endfor %}

          {%- else %}

            {#- old style sidebars: using blocks -- should be deprecated #}

            {%- block sidebartoc %}

            {%- include "localtoc.html" %}

            {%- endblock %}

            {%- block sidebarrel %}

            {%- include "relations.html" %}

            {%- endblock %}

            {%- block sidebarsourcelink %}

            {%- include "sourcelink.html" %}

            {%- endblock %}

            {%- if customsidebar %}

            {%- include customsidebar %}

            {%- endif %}

            {%- block sidebarsearch %}

            {%- include "searchbox.html" %}

            {%- endblock %}

          {%- endif %}

        </div>

      </div>

{%- endmacro %}



{%- macro script() %}

    <script type="text/javascript">

      var DOCUMENTATION_OPTIONS = {

        URL_ROOT:    '{{ url_root }}',

        VERSION:     '{{ release|e }}',

        COLLAPSE_INDEX: false,

        FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',

        HAS_SOURCE:  {{ has_source|lower }}

      };

    </script>

    {%- for scriptfile in script_files %}

    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>

    {%- endfor %}

    <script type="text/javascript" src="{{ pathto('_static/js/copybutton.js', 1) }}"></script>

{%- endmacro %}



{%- macro css() %}

    <link rel="stylesheet" type="text/css" href="{{ pathto('_static/css/spc-bootstrap.css', 1) }}">

    <link rel="stylesheet" type="text/css" href="{{ pathto('_static/css/spc-extend.css', 1) }}">

    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" >

    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" >

    {%- for cssfile in css_files %}

    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" >

    {%- endfor %}

{%- endmacro %}



<html>

  <head>

    <meta charset="{{ encoding }}">

    {{ metatags }}

    {%- block htmltitle %}

    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>

    {%- endblock %}

    {{ css() }}

    {%- if not embedded %}

    {{ script() }}

    {%- if use_opensearch %}

    <link rel="search" type="application/opensearchdescription+xml"

          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"

          href="{{ pathto('_static/opensearch.xml', 1) }}">

    {%- endif %}

    {%- if favicon %}

    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}">

    {%- endif %}

    {%- endif %}

{%- block linktags %}

    {%- if hasdoc('about') %}

    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" >

    {%- endif %}

    {%- if hasdoc('genindex') %}

    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" >

    {%- endif %}

    {%- if hasdoc('search') %}

    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" >

    {%- endif %}

    {%- if hasdoc('copyright') %}

    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" >

    {%- endif %}

    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" >

    {%- if parents %}

    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" >

    {%- endif %}

    {%- if next %}

    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" >

    {%- endif %}

    {%- if prev %}

    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" >

    {%- endif %}

{%- endblock %}

{%- block extrahead %} {% endblock %}

  </head>

  <body>

{%- block header %}

{% if theme_scipy_org_logo %}

<div class="container">

  <div class="top-scipy-org-logo-header">

    <a href="{{ pathto('index') }}">

      <img style="border: 0;" alt="SciPy" src="{{ pathto('_static/img/scipy_org_logo.gif', 1) }}"></a>

    </div>

  </div>

</div>

{% else %}

  <div class="container">

    <div class="header">

    </div>

  </div>

{% endif %}

{% endblock %}



{%- block content %}

    <div class="container">

      <div class="main">

{%- block navbar %}

        {% if theme_navigation_links or sidebar == 'left' %}

	<div class="row-fluid">

	  <div class="span12">

	    <div class="spc-navbar">

              {{ relbar_top() }}

              {% if theme_navigation_links %}

              {{ relbar_top_right() }}

              {% endif %}

	    </div>

	  </div>

	</div>

        {% endif %}

{% endblock %}

	<div class="row-fluid">

	  {%- if theme_sidebar == 'left' -%}

            {{ sidebar() }}

          {%- endif %}

	  {%- if theme_sidebar == 'none' -%}

          <div class="span1"></div>

          <div class="span10">

	  {% else %}

          <div class="span9">

	  {%- endif %}

            {% if not theme_navigation_links and sidebar != 'left' %}

	      <div class="row-fluid">

		<div class="span9">

  		  <div class="spc-navbar">

		    {{ relbar_top() }}

		  </div>

		</div>

	      </div>

            {% endif %}

  {%- block document %}

        <div class="bodywrapper">

          <div class="body" id="spc-section-body">

            {% block body %} {% endblock %}

          </div>

        </div>

  {%- endblock %}

          </div>

	  {%- if theme_sidebar == 'right' -%}

          {{ sidebar() }}

	  {%- elif theme_sidebar == 'none' -%}

          <div class="span1"></div>

	  {%- endif %}

        </div>

      </div>

    </div>

{%- endblock %}



    <div class="container container-navbar-bottom">

      <div class="spc-navbar">

        {{ relbar_bottom() }}

      </div>

    </div>



{%- block footer %}

    <div class="container">

    <div class="footer">

    <div class="row-fluid">

    <ul class="inline pull-left">

    {%- if show_copyright %}

      <li>

      {%- if hasdoc('copyright') %}

        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}

      {%- else %}

        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}

      {%- endif %}

      </li>

    {%- endif %}

    {%- if last_updated %}

      <li>

      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

      </li>

    {%- endif %}

    {%- if show_sphinx %}

      <li>

      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

      </li>

    {%- endif %}

    </ul>

    </div>

    </div>

    </div>

{%- endblock %}

  </body>

</html>

docs/_theme/scipy/searchbox.html

0 → 100644
+13 −0
Original line number Diff line number Diff line 
{%- if theme_edit_link -%}

{% block edit_link %}

{%- if sourcename %}

<div class="this-page-menu">

{%- if 'generated/' in sourcename %}

  <a href="/scipy/docs/{{ sourcename.replace('generated/', '').replace('.txt', '') |e }}">{{_('Edit page')}}</a>

{%- else %}

  <a href="/scipy/docs/scipy-docs/{{ sourcename.replace('.txt', '.rst') |e }}">{{_('Edit page')}}</a>

{%- endif %}

</div>

{%- endif %}

{% endblock %}

{%- endif -%}

docs/_theme/scipy/sourcelink.html

0 → 100644
+7 −0
Original line number Diff line number Diff line 
{%- if show_source and has_source and sourcename %}

  <h3>{{ _('This Page') }}</h3>

  <div>

    <a href="{{ pathto('_sources/' + sourcename, true)|e }}"

       rel="nofollow">{{ _('Show Source') }}</a>

  </div>

{%- endif %}

docs/_theme/scipy/static/css/extend.css

0 → 100644
+116 −0
Original line number Diff line number Diff line 
.container {

  width: 80%;

}

.navbar1 {

  padding-bottom: 10px;

}

.navbar1 .nav-pills {

  margin-bottom: 0px;

  font-size: 12px;

}

.navbar1 .nav-pills > li > a {

  padding-top: 2.5px;

  padding-bottom: 2.5px;

}

.navbar1 .dropdown.dropdown-menu {

	padding: 0px;

}

.header {

  padding-top: 30px;

  padding-bottom: 18px;

}

.SearchBar .form-search {

  margin-bottom: 0px;

}

.SearchBar .input-append input {

  height: 12px;

}

body {

  font-family: Segoe UI;

  background-color: #f9faf7;

}

.main {

  background-color: white;

  padding: 18px;

  -moz-box-shadow: 0 0 3px #888;

  -webkit-box-shadow: 0 0 3px #888;

  box-shadow: 0 0 3px #888;

}

.MainHeader h1 {

  font-weight: normal;

}

.content .contentTitle h4 {

  font-size: 18px;

  font-weight: normal;

}

.content .meta {

  font-size: small;

}

.tags .btn {

  border: none;

  font-size: 10px;

  font-weight: bold;

}

.navigation {

  font-size: 12px;

  padding-bottom: 12px;

}

.navigation .nav-title {

  color: #333333;

  font-family: "Segoe UI semibold";

  font-size: 16px;

  text-transform: uppercase;

}

.navigation li {

  margin: 5px;

}

.snippetHeader {

  margin-bottom: 5px;

}

.snippetHeader .snippetTitle {

  font-size: 21px;

  line-height: 40px;

  border-bottom: 1px solid #e5e5e5;

  display: block;

  color: #333333;

}

.snippetInfo {

  padding-top: 10px;

}

.snippetInfo .dl-horizontal {

  margin: 5px;

}

.snippet-body {

  padding: 10px;

}

.snippet-body .accordion-group {

  border: none;

}

.snippet-body .accordion-heading {

  text-transform: uppercase;

  font-size: 14px;

  border-bottom: 1px solid #e5e5e5;

}

.snippet-body .accordion-heading .accordion-toggle {

  padding-top: 10px;

  padding-bottom: 5px;

}

.SearchResult {

  padding: 10px;

  padding-top: 0px;

}

.SearchResult .PageTitle {

  font-size: 21px;

  line-height: 40px;

  border-bottom: 1px solid #e5e5e5;

  padding-bottom: 5px;

  display: block;

  color: #333333;

}

.footer {

  padding: 10px;

}

.footer-inside {

  border-top: 1px solid #e5e5e5;

  padding: 10px;

}

docs/_theme/scipy/static/css/pygments.css

0 → 100644
+87 −0
Original line number Diff line number Diff line 
/* Styling for the source code listings: (mostly from pygments)*/



.highlight pre{

    overflow: auto;

    padding: 5px;

    background-color: #ffffff;

    color: #333333;

    border: 1px solid #ac9;

    border-left: none;

    border-right: none;

}



/* Styling for pre elements: from http://perishablepress.com/press/2009/11/09/perfect-pre-tags/ */

/* no vertical scrollbars for IE 6 */

* html pre {

	padding-bottom:25px;

	overflow-y:hidden;

	overflow:visible;

	overflow-x:auto

}

/* no vertical scrollbars for IE 7 */

*:first-child+html pre {

	padding-bottom:25px;

	overflow-y:hidden;

	overflow:visible;

	overflow-x:auto

}



div#spc-section-body td.linenos pre {

    padding: 5px 0px;

    border: 0;

    background-color: transparent;

    color: #aaa;

}

.highlight .hll { background-color: #ffffcc }

.highlight  { background: #ffffff; }

.highlight .c { color: #008000 } /* Comment */

.highlight .k { color: #000080; font-weight: bold } /* Keyword */

.highlight .n { color: #000000 } /* Name */

.highlight .o { color: #000000 } /* Operator */

.highlight .cm { color: #008000 } /* Comment.Multiline */

.highlight .cp { color: #008000 } /* Comment.Preproc */

.highlight .c1 { color: #008000 } /* Comment.Single */

.highlight .cs { color: #008000 } /* Comment.Special */

.highlight .kc { color: #000080; font-weight: bold } /* Keyword.Constant */

.highlight .kd { color: #000080; font-weight: bold } /* Keyword.Declaration */

.highlight .kn { color: #000080; font-weight: bold } /* Keyword.Namespace */

.highlight .kp { color: #000080; font-weight: bold } /* Keyword.Pseudo */

.highlight .kr { color: #000080; font-weight: bold } /* Keyword.Reserved */

.highlight .kt { color: #000080; font-weight: bold } /* Keyword.Type */

.highlight .m { color: #008080 } /* Literal.Number */

.highlight .s { color: #800080 } /* Literal.String */

.highlight .na { color: #000000 } /* Name.Attribute */

.highlight .nb { color: #407090 } /* Name.Builtin */

.highlight .nc { color: #0000F0; font-weight: bold } /* Name.Class */

.highlight .no { color: #000000 } /* Name.Constant */

.highlight .nd { color: #000000 } /* Name.Decorator */

.highlight .ni { color: #000000 } /* Name.Entity */

.highlight .ne { color: #000000 } /* Name.Exception */

.highlight .nf { color: #008080; font-weight: bold } /* Name.Function */

.highlight .nl { color: #000000 } /* Name.Label */

.highlight .nn { color: #000000 } /* Name.Namespace */

.highlight .nx { color: #000000 } /* Name.Other */

.highlight .py { color: #000000 } /* Name.Property */

.highlight .nt { color: #000000 } /* Name.Tag */

.highlight .nv { color: #000000 } /* Name.Variable */

.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */

.highlight .mf { color: #008080 } /* Literal.Number.Float */

.highlight .mh { color: #008080 } /* Literal.Number.Hex */

.highlight .mi { color: #008080 } /* Literal.Number.Integer */

.highlight .mo { color: #008080 } /* Literal.Number.Oct */

.highlight .sb { color: #800080 } /* Literal.String.Backtick */

.highlight .sc { color: #800080 } /* Literal.String.Char */

.highlight .sd { color: #800000 } /* Literal.String.Doc */

.highlight .s2 { color: #800080 } /* Literal.String.Double */

.highlight .se { color: #800080 } /* Literal.String.Escape */

.highlight .sh { color: #800080 } /* Literal.String.Heredoc */

.highlight .si { color: #800080 } /* Literal.String.Interpol */

.highlight .sx { color: #800080 } /* Literal.String.Other */

.highlight .sr { color: #800080 } /* Literal.String.Regex */

.highlight .s1 { color: #800080 } /* Literal.String.Single */

.highlight .ss { color: #800080 } /* Literal.String.Symbol */

.highlight .bp { color: #407090 } /* Name.Builtin.Pseudo */

.highlight .vc { color: #000000 } /* Name.Variable.Class */

.highlight .vg { color: #000000 } /* Name.Variable.Global */

.highlight .vi { color: #000000 } /* Name.Variable.Instance */

.highlight .il { color: #008080 } /* Literal.Number.Integer.Long */