conf.py
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Thu, Nov 14, 02:47

conf.py
View Options

	# -- coding: utf-8 --
	#
	# Invenio documentation build configuration file, created by
	# sphinx-quickstart on Fri Oct 11 10:18:35 2013.
	#
	# 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.
	#
	# This file is part of Invenio.
	# Copyright (C) 2014, 2015 CERN.
	#
	# Invenio is free software; you can redistribute it and/or
	# modify it under the terms of the GNU General Public License as
	# published by the Free Software Foundation; either version 2 of the
	# License, or (at your option) any later version.
	#
	# Invenio is distributed in the hope that it will be useful, but
	# WITHOUT ANY WARRANTY; without even the implied warranty of
	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	# General Public License for more details.
	#
	# You should have received a copy of the GNU General Public License
	# along with Invenio; if not, write to the Free Software Foundation, Inc.,
	# 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

	"""Sphinx configuration."""

	from __future__ import print_function

	import os
	import sys

	_html_theme = "default"
	_html_theme_path = []
	try:
	import sphinx_rtd_theme
	_html_theme = "sphinx_rtd_theme"
	_html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
	except ImportError:
	print("Template `sphinx_rtd_theme` not found, pip install it",
	file=sys.stderr)

	# 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('.'))
	sys.path.append(os.path.abspath('_ext'))
	#sys.path.append(os.path.abspath('_themes'))
	#sys.path.append(os.path.abspath('.'))
	sys.path.append(os.path.abspath('../invenio'))


	def setup(app):
	"""Custom application tweaks."""
	app.add_stylesheet("theme_overrides.css")


	# -- 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 = ['flask_app',
	'sphinx.ext.autodoc',
	'sphinx.ext.doctest',
	'sphinx.ext.intersphinx']

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

	# Many pot files are generated under following directory.
	locale_dirs = ['locale/']

	# 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'Invenio'
	copyright = u'2013, 2014, 2015 CERN'

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

	# Get the version string. Cannot be done with import!
	g = {}
	with open(os.path.join('..', 'invenio', 'version.py'), 'rt') as fp:
	exec(fp.read(), g)
	version = g["__version__"]

	# The full version, including alpha/beta/rc tags.
	release = 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 patterns, relative to source directory, that match files and
	# directories to ignore when looking for source files.
	exclude_patterns = ['_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. See the documentation for
	# a list of builtin themes.
	#html_theme = 'default'
	html_theme = _html_theme

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

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


	# -- 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', 'Invenio.tex', u'Invenio Documentation', u'CERN', '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

	# 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', 'invenio', u'Invenio Documentation',
	[u'CERN'], 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', 'Invenio', u'Invenio Documentation', u'CERN', 'Invenio',
	'One line description of project.', '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'

	# -- Options for Intersphinx mapping ------------------------------------------

	# See <http://sphinx-doc.org/ext/intersphinx.html>
	intersphinx_mapping = {
	'python': ('https://docs.python.org/2.7/', None),
	'flaskregistry': ('http://flask-registry.readthedocs.org/en/latest/',
	None),
	#'flaskmenu': ('http://flask-menu.readthedocs.org/en/latest/', None),
	#'flaskbreadcrumbs': (
	# 'http://flask-breadcrumbs.readthedocs.org/en/latest/',
	# None),
	'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
	'flask': ('http://flask.pocoo.org/docs/', None),
	'flaskassets': ('http://flask-assets.readthedocs.org/en/latest/', None),
	'flaskscript': ('http://flask-script.readthedocs.org/en/latest/', None),
	'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None),
	'jinja': ('http://jinja.pocoo.org/docs/', None),
	'webassets': ('http://webassets.readthedocs.org/en/latest/', None),
	# FIXME not readable due to ValueError: unknown or unsupported inv version
	#'flasklogin': ('http://flask-login.readthedocs.org/en/latest/')
	}

conf.pyNo OneTemporaryActions

File Metadata

conf.pyView Options

Event Timeline

conf.py
No OneTemporary
Actions

conf.py
View Options