conf.py

# -*- coding: utf-8 -*-
#
# AutoPart documentation build configuration file, created by
# sphinx-quickstart on Wed Jan 20 15:29:37 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.

'''

Todo for Launch
===============

0. Test all code and documentation
1. Push source to code.google.com
2. Package source zip for code.google.com `downloads`
3. Publish source to PyPI
4. Publish documentation to website
5. Announce on 3dem-request@ncmir.ucsd.edu
6. Create code.google.com/arachnid-docs with SVN - http://manjeetdahiya.com/2010/09/29/serving-html-documentation-from-google-code-svn/
9. Create script to publish code, source zip, documentation and ?binary?
10. Script building tutorial (general)
'''

#import sys, os
import arachnid





# 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('.'))

# -- 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.
extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.todo', 'sphinx.ext.coverage']
jsmath_path = 'jsMath/easy/load.js'

coverage_ignore_functions=['setView', 'init_process', 'check_options', 'dependents', 'initialize', 'main', 'change_option_defaults', 'setup_options', 'reduce_all', 'finalize', 'configuration', 'rglob', 'build_description']
coverage_ignore_classes=['check_dep', 'VersionChange', 'OptionValueError', 'ProcessException', 'SpiderParameterError', 'SpiderCommandError'] # These are exceptions with little documentation

# Add any paths that contain templates here, relative to this directory.
templates_path = ['docs/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'

autosummary_generate=True

# General information about the project.
project = arachnid.__project__
copyright = arachnid.__copyright__[14:]

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

# 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 = ['resources', 'git-hooks', 'build', 'dist', 'docs/themes', 'docs/templates', 'docs/images', 'docs/includes']#, 'arachnid/core/gui/icons']

# 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 = False


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

#1133672
#1132167
# -- 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 = 'haiku'
#html_theme = 'scrolls'

import os
html_theme = 'arachnid'
html_theme_path = [os.path.abspath('docs/themes')]
html_theme_options = {
    "navbar_site_name": 'Site Map',
    "navbar_sidebarrel": False,
    "navbar_pagenav": False,
    "globaltoc_includehidden": True,
    "navbar_fixed_top": True,
    "globaltoc_depth": 0,
    "navbar_links": [('Blog', 'http://blog.arachnid.us/'), ('Issues', 'http://github.com/ezralanglois/arachnid/issues'), ('Mailing List', 'http://groups.google.com/group/arachnid-general')]
}
html_sidebars = {'docs/*': ['localtoc.html'], 'docs/api_generated/*': ['apitoc.html', 'localtoc.html']} #, 'docs/api_generated/api_generated/*': ['localtoc.html']}


html_show_sphinx=False

# 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 = "docs/images/icons/icons/icon16x16.png"
#html_logo = "resources/icons/icon64x64.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 = "docs/images/icons/logo/favicon.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 = ['docs/images/icons/logo/']#'resources/static']
#html_style=''#nature_fixed.css'

# 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 = False

# 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 = 'arachnid-doc'

todo_include_todos = False


# todo glob for all inc files
rst_epilog = '''
.. |pys| replace:: pySPIDER
.. |spi| replace:: pySPIDER
'''
#"".join(open('docs/include/option_details.inc').readlines())


# -- 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', 'arachnid.tex', arachnid.__project__+' Documentation',
   arachnid.__author__ , '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