9bc01ae265
The idea is to filter the sources, replacing @<var>@ occurrences with the mapping for <var> (which is currently hard-coded). @@ -> @. In order to make this work, I had to move the doc sources one directory down (into akka-docs/rst) so that the filtered result could be in a sibling directory so that relative links (to _sphinx plugins or real code) would continue to work. While I was at it I also changed it so that WARNINGs and ERRORs are not swallowed into the debug dump anymore but printed at [warn] level (minimum). One piece of fallout is that the (online) html build is now run after the normal one, not in parallel.
85 lines
2.2 KiB
Python
85 lines
2.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Akka documentation build configuration file.
|
|
#
|
|
|
|
import sys, os
|
|
|
|
# -- General configuration -----------------------------------------------------
|
|
|
|
sys.path.append(os.path.abspath('../_sphinx/exts'))
|
|
extensions = ['sphinx.ext.todo', 'includecode']
|
|
|
|
templates_path = ['_templates']
|
|
source_suffix = '.rst'
|
|
master_doc = 'index'
|
|
exclude_patterns = ['_build', 'pending', 'disabled']
|
|
|
|
project = u'Akka'
|
|
copyright = u'2011, Typesafe Inc'
|
|
version = '@version@'
|
|
release = '@version@'
|
|
|
|
pygments_style = 'simple'
|
|
highlight_language = 'scala'
|
|
add_function_parentheses = False
|
|
show_authors = True
|
|
|
|
# -- Options for HTML output ---------------------------------------------------
|
|
|
|
html_theme = 'akka'
|
|
html_theme_path = ['../_sphinx/themes']
|
|
html_favicon = '../_sphinx/static/favicon.ico'
|
|
|
|
html_title = 'Akka Documentation'
|
|
html_logo = '../_sphinx/static/logo.png'
|
|
#html_favicon = None
|
|
|
|
html_static_path = ['../_sphinx/static']
|
|
|
|
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'
|
|
html_use_smartypants = False
|
|
html_add_permalinks = ''
|
|
|
|
html_context = {
|
|
'include_analytics': 'online' in tags
|
|
}
|
|
|
|
# -- 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", "")
|
|
|
|
# -- Options for LaTeX output --------------------------------------------------
|
|
|
|
def setup(app):
|
|
from sphinx.util.texescape import tex_replacements
|
|
tex_replacements.append((u'⇒', ur'\(\Rightarrow\)'))
|
|
|
|
latex_paper_size = 'a4'
|
|
latex_font_size = '10pt'
|
|
|
|
latex_documents = [
|
|
('index', 'Akka.tex', u' Akka Documentation',
|
|
u'Typesafe Inc', 'manual'),
|
|
]
|
|
|
|
latex_elements = {
|
|
'classoptions': ',oneside,openany',
|
|
'babel': '\\usepackage[english]{babel}',
|
|
'fontpkg': '\\PassOptionsToPackage{warn}{textcomp} \\usepackage{times}',
|
|
'preamble': '\\definecolor{VerbatimColor}{rgb}{0.935,0.935,0.935}'
|
|
}
|
|
|
|
# latex_logo = '_sphinx/static/akka.png'
|