2011-04-06 14:15:59 +02:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
#
|
|
|
|
|
# Akka documentation build configuration file.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
import sys, os
|
|
|
|
|
|
|
|
|
|
# -- General configuration -----------------------------------------------------
|
|
|
|
|
|
2011-04-20 18:02:11 +12:00
|
|
|
sys.path.append(os.path.abspath('_sphinx/exts'))
|
2012-09-18 10:19:40 +02:00
|
|
|
extensions = ['sphinx.ext.todo', 'includecode']
|
2011-04-06 14:15:59 +02:00
|
|
|
|
|
|
|
|
templates_path = ['_templates']
|
|
|
|
|
source_suffix = '.rst'
|
|
|
|
|
master_doc = 'index'
|
2011-04-27 10:04:18 +12:00
|
|
|
exclude_patterns = ['_build', 'pending', 'disabled']
|
2011-04-06 14:15:59 +02:00
|
|
|
|
|
|
|
|
project = u'Akka'
|
2011-05-16 08:34:55 +02:00
|
|
|
copyright = u'2011, Typesafe Inc'
|
2012-03-05 10:50:54 +13:00
|
|
|
version = '2.1-SNAPSHOT'
|
|
|
|
|
release = '2.1-SNAPSHOT'
|
2011-04-06 14:15:59 +02:00
|
|
|
|
2011-04-19 12:43:50 +12:00
|
|
|
pygments_style = 'simple'
|
2011-04-06 14:15:59 +02:00
|
|
|
highlight_language = 'scala'
|
2011-04-17 16:37:53 +02:00
|
|
|
add_function_parentheses = False
|
|
|
|
|
show_authors = True
|
2011-04-06 14:15:59 +02:00
|
|
|
|
2012-08-17 00:07:56 +02:00
|
|
|
f = open('epilog_rst', 'U')
|
|
|
|
|
rst_epilog = "\n" + f.read()
|
|
|
|
|
f.close()
|
|
|
|
|
|
2011-04-06 14:15:59 +02:00
|
|
|
# -- Options for HTML output ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
html_theme = 'akka'
|
2011-04-20 18:02:11 +12:00
|
|
|
html_theme_path = ['_sphinx/themes']
|
2012-03-06 13:20:00 +13:00
|
|
|
html_favicon = '_sphinx/static/favicon.ico'
|
2011-04-06 14:15:59 +02:00
|
|
|
|
|
|
|
|
html_title = 'Akka Documentation'
|
2011-04-20 18:02:11 +12:00
|
|
|
html_logo = '_sphinx/static/logo.png'
|
2011-04-06 14:15:59 +02:00
|
|
|
#html_favicon = None
|
|
|
|
|
|
2011-04-20 18:02:11 +12:00
|
|
|
html_static_path = ['_sphinx/static']
|
2011-04-06 14:15:59 +02:00
|
|
|
|
|
|
|
|
html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
|
#html_sidebars = {}
|
|
|
|
|
#html_additional_pages = {}
|
|
|
|
|
html_domain_indices = False
|
|
|
|
|
html_use_index = False
|
|
|
|
|
html_show_sourcelink = False
|
|
|
|
|
html_show_sphinx = False
|
|
|
|
|
html_show_copyright = True
|
|
|
|
|
htmlhelp_basename = 'Akkadoc'
|
2012-09-10 16:37:29 +02:00
|
|
|
html_use_smartypants = False
|
2012-03-06 13:20:00 +13:00
|
|
|
html_add_permalinks = ''
|
2011-04-06 14:15:59 +02:00
|
|
|
|
2012-05-10 11:03:43 +12:00
|
|
|
html_context = {
|
|
|
|
|
'include_analytics': 'online' in tags
|
|
|
|
|
}
|
|
|
|
|
|
2012-05-17 22:58:57 +02:00
|
|
|
# -- Options for EPUB output ---------------------------------------------------
|
|
|
|
|
epub_author = "Typesafe Inc"
|
|
|
|
|
epub_language = "en"
|
|
|
|
|
epub_publisher = epub_author
|
|
|
|
|
epub_identifier = "http://doc.akka.io/docs/akka/snapshot/"
|
|
|
|
|
epub_scheme = "URL"
|
|
|
|
|
epub_cover = ("_sphinx/static/akka.png", "")
|
|
|
|
|
|
2011-04-06 14:15:59 +02:00
|
|
|
# -- Options for LaTeX output --------------------------------------------------
|
|
|
|
|
|
2011-10-12 10:55:35 +02:00
|
|
|
def setup(app):
|
2012-03-06 13:20:00 +13:00
|
|
|
from sphinx.util.texescape import tex_replacements
|
|
|
|
|
tex_replacements.append((u'⇒', ur'\(\Rightarrow\)'))
|
2011-10-12 10:55:35 +02:00
|
|
|
|
2011-04-06 14:15:59 +02:00
|
|
|
latex_paper_size = 'a4'
|
|
|
|
|
latex_font_size = '10pt'
|
|
|
|
|
|
|
|
|
|
latex_documents = [
|
|
|
|
|
('index', 'Akka.tex', u' Akka Documentation',
|
2011-10-12 10:55:35 +02:00
|
|
|
u'Typesafe Inc', 'manual'),
|
2011-04-06 14:15:59 +02:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
latex_elements = {
|
|
|
|
|
'classoptions': ',oneside,openany',
|
|
|
|
|
'babel': '\\usepackage[english]{babel}',
|
2011-10-12 10:55:35 +02:00
|
|
|
'fontpkg': '\\PassOptionsToPackage{warn}{textcomp} \\usepackage{times}',
|
2011-04-06 14:15:59 +02:00
|
|
|
'preamble': '\\definecolor{VerbatimColor}{rgb}{0.935,0.935,0.935}'
|
|
|
|
|
}
|
|
|
|
|
|
2011-04-20 18:02:11 +12:00
|
|
|
# latex_logo = '_sphinx/static/akka.png'
|