Source

possumpalace_kit / default_conf.py

Full commit
# -*- coding: utf-8 -*-
##
# 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.
here = os.path.abspath('.')
sys.path.append(here)
sys.path.append(os.path.join(here, '../_ext'))
sys.path.append(os.path.join(here, '_ext'))

# -- 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.mathjax',
  'sphinx.ext.ifconfig',
  'possumpalace',
  'sphinxcontrib.feed',
  'sphinx.ext.todo'
]

# mathjax_path = 'http://mathjax.connectmv.com/MathJax.js'

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = [
  '_build',
  '_lib',
  '_static',
  '_ext',
  '_themes',
  '_templates',
  'content/_lib',
  'content/_static',
  'content/_ext',
  'content/_themes',
  'content/_templates',
  'drafts',
  # 'reviews/content',
  'bibliography',
  'content/bibliography',
]

review_dir = 'reviews'
# review_content_subdir = 'content'
bibdoc_dir = 'bibliography'

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

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes', '../_themes']

# 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', '../_static']


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


# 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'Possum Palace'
copyright = u'2011, Dan MacKinlay except where otherwise specified'

publicness = 'public'

feed_filename = 'feed.rss'

# 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.0'
# # The full version, including alpha/beta/rc tags.
# release = '0.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 documents that shouldn't be included in the build.
#unused_docs = []


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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

exclude_dirnames = ['.svn', '.git', '.hg']


# -- 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 = 'longago'
html_theme = 'algo'

html_theme_options = { #default version
  # "rightsidebar": "true", 
  # "relbarbgcolor": "black",
# "footerbgcolor": "#11303d",
# "footertextcolor": "#ffffff",
  # "sidebarbgcolor": "#1c4e63",
# "sidebartextcolor": "#ffffff",
# "sidebarlinkcolor": "#98dbcc",
# "relbartextcolor": "#ffffff",
# "relbarlinkcolor": "#ffffff",
  # "bgcolor": "#ffffff",
  # "textcolor": "#000000",
# "headbgcolor": "#f2f2f2",
  # "headtextcolor": "#20435c",
  # "headlinkcolor": "#c60f0f",
  # "linkcolor": '#355f7c,',
  # "visitedlinkcolor": "#355f7c",
# "codebgcolor": "#eeffcc",
# "codetextcolor": "#333333",
} 

html_theme_options = { #algo version
    # "bodyfont": '"Verdana", Arial, sans-serif',
    # "headerfont": '"Georgia", "Times New Roman", serif',
    # "pagewidth": '70em',
    # "documentwidth": '50em',
    # "sidebarwidth": '20em',
    # "bgcolor": '#879150',
    "headerbg": 'url(bgtop.jpg) top left repeat-x',
    # "footerbg": 'url(bgfooter.png) top left repeat-x',
    # "footercolor": '#444444',
    # "linkcolor": '#355f7c,',
    # "headercolor1": '#204a87',
    # "headercolor2": '#3465a4',
    # "headerlinkcolor": '#fcaf3e',
}
# 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


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

# If false, no index is generated.
html_use_index = True

html_translator_class = "possumpalace.PossumPalaceHTMLTranslator"

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

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

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

# -- Options for LaTeX output --------------------------------------------------
latex_translator_class = "possumpalace.PossumPalaceLaTeXWriter"

# 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', 'PossumPalace.tex', u'Possum Palace Documentation',
   u'Dan MacKinlay', '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 = False

todo_include_todos = False

extlinks = {'culref': ('http://www.citeulike.org/user/livingthingdan/article/%s', None)}