DOC: very basic hack to separate vbench project from main docs, generate chapters by module. Need some prettification, close #718

Author: wesm

doc/source/index.rst

@@ -125,4 +125,4 @@ See the package overview for more detail about what's in the library.
     related
     comparison_with_r
     api
-    vbench
+

vb_suite/.gitignore

@@ -1 +1,4 @@
-benchmarks.db
+benchmarks.db
+build/*
+source/vbench/*
+source/*.rst

vb_suite/attrs_caching.py

@@ -0,0 +1,20 @@
+from vbench.benchmark import Benchmark
+
+common_setup = """from pandas_vb_common import *
+"""
+
+#----------------------------------------------------------------------
+# DataFrame.index / columns property lookup time
+
+setup = common_setup + """
+df = DataFrame(np.random.randn(10, 6))
+cur_index = df.index
+"""
+stmt = "foo = df.index"
+
+getattr_dataframe_index = Benchmark(stmt, setup,
+                                    name="getattr_dataframe_index")
+
+stmt = "df.index = cur_index"
+setattr_dataframe_index = Benchmark(stmt, setup,
+                                    name="setattr_dataframe_index")

vb_suite/make.py

@@ -0,0 +1,108 @@
+#!/usr/bin/env python
+
+"""
+Python script for building documentation.
+
+To build the docs you must have all optional dependencies for statsmodels
+installed. See the installation instructions for a list of these.
+
+Note: currently latex builds do not work because of table formats that are not
+supported in the latex generation.
+
+Usage
+-----
+python make.py clean
+python make.py html
+"""
+
+import glob
+import os
+import shutil
+import sys
+import sphinx
+
+os.environ['PYTHONPATH'] = '..'
+
+SPHINX_BUILD = 'sphinxbuild'
+
+def sf():
+    'push a copy to the sf site'
+    os.system('cd build/html; rsync -avz . wesmckinn,[email protected]'
+              ':/home/groups/p/pa/pandas/htdocs/ -essh --cvs-exclude')
+def sfpdf():
+    'push a copy to the sf site'
+    os.system('cd build/latex; scp pandas.pdf wesmckinn,[email protected]'
+              ':/home/groups/p/pa/pandas/htdocs/')
+
+def clean():
+    if os.path.exists('build'):
+        shutil.rmtree('build')
+
+    if os.path.exists('source/generated'):
+        shutil.rmtree('source/generated')
+
+def html():
+    check_build()
+    if os.system('sphinx-build -P -b html -d build/doctrees '
+                 'source build/html'):
+        raise SystemExit("Building HTML failed.")
+
+def latex():
+    check_build()
+    if sys.platform != 'win32':
+        # LaTeX format.
+        if os.system('sphinx-build -b latex -d build/doctrees '
+                     'source build/latex'):
+            raise SystemExit("Building LaTeX failed.")
+        # Produce pdf.
+
+        os.chdir('build/latex')
+
+        # Call the makefile produced by sphinx...
+        if os.system('make'):
+            raise SystemExit("Rendering LaTeX failed.")
+
+        os.chdir('../..')
+    else:
+        print 'latex build has not been tested on windows'
+
+def check_build():
+    build_dirs = [
+        'build', 'build/doctrees', 'build/html',
+        'build/latex', 'build/plots', 'build/_static',
+        'build/_templates']
+    for d in build_dirs:
+        try:
+            os.mkdir(d)
+        except OSError:
+            pass
+
+def all():
+    # clean()
+    html()
+
+funcd = {
+    'html'     : html,
+    'latex'    : latex,
+    'clean'    : clean,
+    'sf'       : sf,
+    'sfpdf'    : sfpdf,
+    'all'      : all,
+    }
+
+small_docs = False
+
+# current_dir = os.getcwd()
+# os.chdir(os.path.dirname(os.path.join(current_dir, __file__)))
+
+if len(sys.argv)>1:
+    for arg in sys.argv[1:]:
+        func = funcd.get(arg)
+        if func is None:
+            raise SystemExit('Do not know how to handle %s; valid args are %s'%(
+                    arg, funcd.keys()))
+        func()
+else:
+    small_docs = False
+    all()
+#os.chdir(current_dir)

vb_suite/source/conf.py

@@ -0,0 +1,224 @@
+# -*- coding: utf-8 -*-
+#
+# pandas documentation build configuration file, created by
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../sphinxext'))
+
+sys.path.extend([
+
+    # numpy standard doc extensions
+    os.path.join(os.path.dirname(__file__),
+                 '..', '../..',
+                 'sphinxext')
+
+])
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.  sphinxext.
+
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.doctest']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates', '_templates/autosummary']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'vbench'
+
+# General information about the project.
+project = u'pandas'
+copyright = u'2008-2011, the pandas development team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+import pandas
+
+# version = '%s r%s' % (pandas.__version__, svn_version())
+version = '%s' % (pandas.__version__)
+
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# JP: added from sphinxdocs
+autosummary_generate = True
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'agogo'
+
+# 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 = 'statsmodels.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
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['themes']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'Vbench performance benchmarks for pandas'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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_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 = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = 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. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'performance'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'performance.tex',
+   u'pandas vbench Performance Benchmarks',
+   u'Wes McKinney', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'http://docs.scipy.org/': None}
+import glob
+autosummary_generate = glob.glob("*.rst")