source: trunk/docs/source/conf.py @ 2037

# -*- coding: utf-8 -*-
#
# sphinx documentation build configuration file based on one built by sphinx-quickstart
#
# 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
# set up dummy packages for misc imports not on readthedocs
from mock import Mock as MagicMock
class wx(MagicMock):
    #@classmethod
    #def __getattr__(cls, name):
    #    return wx()
    Menu = Panel = Dialog = CheckBox = Choice = ComboBox = object
    Button = PyValidator = TextCtrl = TreeCtrl = object
    DEFAULT_DIALOG_STYLE = RESIZE_BORDER = CENTRE = OK = CANCEL = True
    ID_ANY = -1
    def __getitem__(self,*args):
        return '3.0.0'
    class grid(object):
        PyGridTableBase = PyGridCellEditor = Grid = object
    class html(object):
        HtmlWindow = object
    class aui(MagicMock):
        AuiNotebook = HtmlWindow = object
    class lib(MagicMock):
        class scrolledpanel(MagicMock):
            ScrolledPanel = object
        class gridmovers(MagicMock): pass
        class colourselect(MagicMock): pass
        class resizewidget(MagicMock): pass

sys.modules.update({'wx':wx()})
sys.modules.update({'wx.aui':wx.aui()})
sys.modules.update({'wx.html':wx.html()})
sys.modules.update({'wx.grid':wx.grid()})
sys.modules.update({'wx.lib':wx.lib()})
sys.modules.update({'wx.wizard':wx.grid()})
sys.modules.update({'wx.glcanvas':wx.lib()})
sys.modules.update({'wx.lib.scrolledpanel':wx.lib.scrolledpanel()})
sys.modules.update({'wx.lib.gridmovers':wx.lib.gridmovers()})
sys.modules.update({'wx.lib.colourselect':wx.lib.gridmovers()})
sys.modules.update({'wx.lib.resizewidget':wx.lib.resizewidget()})

class numpy(MagicMock):
    pi = 3.0
    def log(self,*args): return 0
    def sqrt(self,*args): return 1
    class ma(MagicMock):pass
    class linalg(MagicMock):pass
sys.modules.update({'numpy':numpy()})
sys.modules.update({'numpy.ma':numpy.ma()})
sys.modules.update({'numpy.linalg':numpy.linalg()})
sys.modules.update({'numpy.fft':numpy.linalg()})

class scipy(MagicMock):
    class optimize(MagicMock):pass
sys.modules.update({'scipy':scipy()})
sys.modules.update({'scipy.optimize':scipy.optimize()})
sys.modules.update({'scipy.stats':scipy.optimize()})
sys.modules.update({'scipy.interpolate':scipy.optimize()})
sys.modules.update({'scipy.special':scipy.optimize()})
sys.modules.update({'scipy.misc':scipy.optimize()})

class OpenGL(MagicMock):
    class GL(MagicMock):pass
    class GLU(MagicMock):pass
sys.modules.update({'OpenGL':OpenGL()})
sys.modules.update({'OpenGL.GL':OpenGL.GL()})
sys.modules.update({'OpenGL.GLU':OpenGL.GLU()})
sys.modules.update({'OpenGL.GLE':OpenGL.GL()})

class Mock(MagicMock):
    @classmethod
    def __getattr__(cls, name):
        return Mock()

MOCK_MODULES = [
                'pypowder', 'pyspg', 'pytexture', 'polymask', 'fellipse',
                'matplotlib', 'matplotlib.backends', 'matplotlib.backends.backend_wx', 
                'matplotlib.backends.backend_wxagg','pylab',
                'mpl_toolkits', 'mpl_toolkits.mplot3d', 'mpl_toolkits.mplot3d.axes3d',
                ]
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)


# 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.insert(0, os.path.abspath('.'))
os.path.abspath(os.path.join('..', '..'))
sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
sys.path.insert(1, os.path.abspath(os.path.join('..', '..','exports')))
sys.path.insert(1, os.path.abspath(os.path.join('..', '..','imports')))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'GSAS-II'
copyright = u'2013, Von Dreele and Toby for Argonne National Laboratory'

# 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.
version = '0.2.0'
# The full version, including alpha/beta/rc tags.
release = '0.2.0'

# 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 patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# 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.  See the documentation for
# a list of builtin themes.
html_theme = 'default'
#html_theme = 'agogo'
#html_theme = 'sphinxdoc'

# 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 = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# 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 = 'G2_html_logo.png'

# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = 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 = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'GSASIIdoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
  ('index', 'GSASIIdoc.tex', u'GSAS-II Developers Documentation',
   u'Robert B. Von Dreele and Brian H. Toby', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = 'G2_html_logo.png'

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'GSASIIdoc', u'GSAS-II Developers Documentation',
     [u'Robert B. Von Dreele',u'Brian H. Toby'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    ('index', 'GSASIIdoc', u'GSAS-II Developers Documentation',
   u'Robert B. Von Dreele and Brian H. Toby', 'GSASIIdoc', 'GSAS-II Developers Manual',
   'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'