DOC: use the new scipy-sphinx-theme in the documentation

pv · pv · commit df2198336bf8 · 2013-07-25T14:58:05.000+03:00
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "doc/scipy-sphinx-theme"]
+	path = doc/scipy-sphinx-theme
+	url = https://github.com/scipy/scipy-sphinx-theme.git
diff --git a/doc/scipy-sphinx-theme b/doc/scipy-sphinx-theme
@@ -0,0 +1 @@
+Subproject commit 65c59fe6a516e23db50ecb8ca160b9f9de12dc11
diff --git a/doc/source/_static/scipy.css b/doc/source/_static/scipy.css
diff --git a/doc/source/_templates/indexsidebar.html b/doc/source/_templates/indexsidebar.html
@@ -1,5 +1,4 @@
             <h3>Resources</h3>
             <ul>
               <li><a href="http://scipy.org/">Scipy.org website</a></li>
-              <li>&nbsp;</li>
             </ul>
diff --git a/doc/source/_templates/layout.html b/doc/source/_templates/layout.html
@@ -1,6 +1,9 @@
 {% extends "!layout.html" %}
+
 {% block rootrellink %}
-<li><a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
+        {% if pagename != 'index' %}
+        <li class="active"><a href="{{ pathto('index') }}">{{ shorttitle|e }}</a></li>
+        {% endif %}
 {% endblock %}
 
 {% block sidebarsearch %}
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -30,9 +30,6 @@
 # The suffix of source filenames.
 source_suffix = '.rst'
 
-# The master toctree document.
-#master_doc = 'index'
-
 # General substitutions.
 project = 'NumPy'
 copyright = '2008-2009, The Scipy community'
@@ -83,62 +80,50 @@
 # HTML output
 # -----------------------------------------------------------------------------
 
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'scipy.css'
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-html_title = "%s v%s Manual (DRAFT)" % (project, version)
+themedir = os.path.join(os.pardir, 'scipy-sphinx-theme', '_theme')
+if not os.path.isdir(themedir):
+    raise RuntimeError("Get the scipy-sphinx-theme first, "
+                       "via git submodule init && git submodule update")
+    
+html_theme = 'scipy'
+html_theme_path = [themedir]
+
+if 'scipyorg' in tags:
+    # Build for the scipy.org website
+    html_theme_options = {
+        "edit_link": True,
+        "sidebar": "right",
+        "scipy_org_logo": True,
+        "rootlinks": [("http://scipy.org/", "Scipy.org"),
+                      ("http://docs.scipy.org/", "Docs")]
+    }
+else:
+    # Default build
+    html_theme_options = {
+        "edit_link": False,
+        "sidebar": "left",
+        "scipy_org_logo": False,
+        "rootlinks": []
+    }
+    html_sidebars = {'index': 'indexsidebar.html'}
 
-# The name of an image file (within the static path) to place at the top of
-# the sidebar.
-html_logo = 'scipyshiny_small.png'
+html_additional_pages = {
+    'index': 'indexcontent.html',
+} 
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
+html_title = "%s v%s Manual" % (project, version)
 html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'
 
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-html_sidebars = {
-    'index': 'indexsidebar.html'
-}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-html_additional_pages = {
-    'index': 'indexcontent.html',
-}
-
-# If false, no module index is generated.
+html_use_modindex = True
+html_copy_source = False
 html_domain_indices = False
+html_file_suffix = '.html'
 
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".html").
-#html_file_suffix = '.html'
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = 'numpy'
 
-# Pngmath should try to align formulas properly
 pngmath_use_preview = True
+pngmath_dvipng_args = ['-gamma', '1.5', '-D', '96', '-bg', 'Transparent']
 
 
 # -----------------------------------------------------------------------------
diff --git a/doc/source/scipyshiny_small.png b/doc/source/scipyshiny_small.png

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "doc/scipy-sphinx-theme"]`
	`2`	`+ path = doc/scipy-sphinx-theme`
	`3`	`+ url = https://github.com/scipy/scipy-sphinx-theme.git`