# -*- coding: utf-8 -*-
#
# Astropysics documentation build configuration file, created by
# sphinx-quickstart on Wed Feb 24 00:07:20 2010.
#
# 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(1,os.path.abspath('..')) #make sure it's on top except maybe local dirs

#with open(os.path.join('..','setup.py')) as f:
#    for l in f:
#        if 'version' in l:
#            break
#    else:
#        raise RuntimeError('could not locate setup.py to determine version')
#setup_version = l.split("'")[1]

from astropysics.version import version as setup_version

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

# Builtin sphinx extensions
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 
              'sphinx.ext.pngmath', 'sphinx.ext.inheritance_diagram',
              'sphinx.ext.coverage','sphinx.ext.ifconfig','sphinx.ext.doctest']
              #'matplotlib.sphinxext.plot_directive','matplotlib.sphinxext.ipython_console_highlighting']
              
#custom extensions
extensions.extend(['astropysics.sphinxext.todomod'])

# 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'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Astropysics'
copyright = u'2010, Erik Tollerud'

# 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 = '.'.join(setup_version.split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = setup_version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'en'

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

# 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 = 'default'

# 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 = {'rightsidebar':True,'stickysidebar':True,
                      'bodyfont':'Verdana, Geneva, Helvetica, sans-serif',
                      'headfont':'Georgia, Times, serif',
                      'footerbgcolor'    :'#0053A6',
                      'footertextcolor'  :'#ffffff',
                      'sidebarbgcolor'   :'#707373',
                      'sidebartextcolor' :'#e2e2ea',
                      'sidebarlinkcolor' :'#FF970D',
                      #'sidebarbgcolor'   :'#A3890E',
                      #'sidebartextcolor' :'#e2e2ea',
                      #'sidebarlinkcolor' :'#121D70',
                      'relbarbgcolor'    :'#003366',
                      #'relbarbgcolor'    :'#5D68BC',
                      'relbartextcolor'  :'#ffffff',
                      'relbarlinkcolor'  :'#ffffff',
                      'bgcolor'          :'#eaeeee',
                      'textcolor'        :'#000000',
                      'headbgcolor'      :'#f2f2f2',
                      'headtextcolor'    :'#20435c',
                      'headlinkcolor'    :'#c60f0f',
                      'linkcolor'        :'#ce5c00',
                      'visitedlinkcolor' :'#ce5c00',
                      'codebgcolor'      :'#eeffcc',
                      'codetextcolor'    :'#333333'
                     } 

# 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 = '../logo/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 = 'logo32thin.ico'

# 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','../logo/logo32thin.ico','../logo/logotext.png']

# 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 = 'Astropysicsdoc'


# -- 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', 'Astropysics.tex', u'Astropysics Documentation',
   u'Erik Tollerud', 'manual'),
]

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

# 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


intersphinx_mapping = {'python':('http://docs.python.org/',None),
                       'numpy':('http://docs.scipy.org/doc/numpy/',None),
                       'scipy':('http://docs.scipy.org/doc/scipy/reference/',None),
                       'matplotlib':('http://matplotlib.sourceforge.net/',None),
                       'pymc':('http://pymc.googlecode.com/svn/doc/',None),
                       'networkx':('http://networkx.lanl.gov/',None),
                       'pymodelfit':('http://packages.python.org/PyModelFit/',None)}

autoclass_content = 'both'

todo_include_todos = 'dev' in release

graphviz_output_format = 'png' #can be 'svg' or 'png'
inheritance_graph_attrs = dict(size='"12.0, 12.0"',fontsize=12)

#This makes the add_doc family of functions in astropysics do nothing, as those
#are intended for in-shell use - Sphinx links are better
import astropysics
astropysics._ignore_add_docs = True
