stephan@139: # -*- coding: utf-8 -*- stephan@139: # stephan@139: # MXD2map documentation build configuration file, created by stephan@139: # sphinx-quickstart on Mon Jun 20 09:48:05 2011. stephan@139: # stephan@139: # This file is execfile()d with the current directory set to its containing dir. stephan@139: # stephan@139: # Note that not all possible configuration values are present in this stephan@139: # autogenerated file. stephan@139: # stephan@139: # All configuration values have a default; values that are commented out stephan@139: # serve to show the default. stephan@139: stephan@139: import sys, os stephan@139: stephan@139: # If extensions (or modules to document with autodoc) are in another directory, stephan@139: # add these directories to sys.path here. If the directory is relative to the stephan@139: # documentation root, use os.path.abspath to make it absolute, like shown here. stephan@139: #sys.path.insert(0, os.path.abspath('.')) stephan@139: stephan@139: # -- General configuration ----------------------------------------------------- stephan@139: stephan@139: # If your documentation needs a minimal Sphinx version, state it here. stephan@139: #needs_sphinx = '1.0' stephan@139: stephan@139: # Add any Sphinx extension module names here, as strings. They can be extensions stephan@139: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. stephan@139: extensions = ['sphinx.ext.viewcode'] stephan@139: stephan@139: # Add any paths that contain templates here, relative to this directory. stephan@139: templates_path = ['_templates'] stephan@139: stephan@139: # The suffix of source filenames. stephan@139: source_suffix = '.rst' stephan@139: stephan@139: # The encoding of source files. stephan@139: #source_encoding = 'utf-8-sig' stephan@139: stephan@139: # The master toctree document. stephan@139: master_doc = 'index' stephan@139: stephan@139: # General information about the project. stephan@139: project = u'MXD2map' stephan@139: copyright = u'2011, foo bar' stephan@139: stephan@139: # The version info for the project you're documenting, acts as replacement for stephan@139: # |version| and |release|, also used in various other places throughout the stephan@139: # built documents. stephan@139: # stephan@139: # The short X.Y version. stephan@139: version = '0.0.1' stephan@139: # The full version, including alpha/beta/rc tags. stephan@139: release = '0.0.1' stephan@139: stephan@139: # The language for content autogenerated by Sphinx. Refer to documentation stephan@139: # for a list of supported languages. stephan@139: language = 'de' stephan@139: stephan@139: # There are two options for replacing |today|: either, you set today to some stephan@139: # non-false value, then it is used: stephan@139: #today = '' stephan@139: # Else, today_fmt is used as the format for a strftime call. stephan@139: #today_fmt = '%B %d, %Y' stephan@139: stephan@139: # List of patterns, relative to source directory, that match files and stephan@139: # directories to ignore when looking for source files. stephan@139: exclude_patterns = [] stephan@139: stephan@139: # The reST default role (used for this markup: `text`) to use for all documents. stephan@139: #default_role = None stephan@139: stephan@139: # If true, '()' will be appended to :func: etc. cross-reference text. stephan@139: #add_function_parentheses = True stephan@139: stephan@139: # If true, the current module name will be prepended to all description stephan@139: # unit titles (such as .. function::). stephan@139: #add_module_names = True stephan@139: stephan@139: # If true, sectionauthor and moduleauthor directives will be shown in the stephan@139: # output. They are ignored by default. stephan@139: #show_authors = False stephan@139: stephan@139: # The name of the Pygments (syntax highlighting) style to use. stephan@139: pygments_style = 'sphinx' stephan@139: stephan@139: # A list of ignored prefixes for module index sorting. stephan@139: #modindex_common_prefix = [] stephan@139: stephan@139: stephan@139: # -- Options for HTML output --------------------------------------------------- stephan@139: stephan@139: # The theme to use for HTML and HTML Help pages. See the documentation for stephan@139: # a list of builtin themes. stephan@139: html_theme = 'default' stephan@139: stephan@139: # Theme options are theme-specific and customize the look and feel of a theme stephan@139: # further. For a list of options available for each theme, see the stephan@139: # documentation. stephan@139: #html_theme_options = {} stephan@139: stephan@139: # Add any paths that contain custom themes here, relative to this directory. stephan@139: #html_theme_path = [] stephan@139: stephan@139: # The name for this set of Sphinx documents. If None, it defaults to stephan@139: # " v documentation". stephan@139: #html_title = None stephan@139: stephan@139: # A shorter title for the navigation bar. Default is the same as html_title. stephan@139: #html_short_title = None stephan@139: stephan@139: # The name of an image file (relative to this directory) to place at the top stephan@139: # of the sidebar. stephan@139: #html_logo = None stephan@139: stephan@139: # The name of an image file (within the static path) to use as favicon of the stephan@139: # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 stephan@139: # pixels large. stephan@139: #html_favicon = None stephan@139: stephan@139: # Add any paths that contain custom static files (such as style sheets) here, stephan@139: # relative to this directory. They are copied after the builtin static files, stephan@139: # so a file named "default.css" will overwrite the builtin "default.css". stephan@139: html_static_path = ['_static'] stephan@139: stephan@139: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, stephan@139: # using the given strftime format. stephan@139: #html_last_updated_fmt = '%b %d, %Y' stephan@139: stephan@139: # If true, SmartyPants will be used to convert quotes and dashes to stephan@139: # typographically correct entities. stephan@139: #html_use_smartypants = True stephan@139: stephan@139: # Custom sidebar templates, maps document names to template names. stephan@139: #html_sidebars = {} stephan@139: stephan@139: # Additional templates that should be rendered to pages, maps page names to stephan@139: # template names. stephan@139: #html_additional_pages = {} stephan@139: stephan@139: # If false, no module index is generated. stephan@139: #html_domain_indices = True stephan@139: stephan@139: # If false, no index is generated. stephan@139: #html_use_index = True stephan@139: stephan@139: # If true, the index is split into individual pages for each letter. stephan@139: #html_split_index = False stephan@139: stephan@139: # If true, links to the reST sources are added to the pages. stephan@139: #html_show_sourcelink = True stephan@139: stephan@139: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. stephan@139: #html_show_sphinx = True stephan@139: stephan@139: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. stephan@139: #html_show_copyright = True stephan@139: stephan@139: # If true, an OpenSearch description file will be output, and all pages will stephan@139: # contain a tag referring to it. The value of this option must be the stephan@139: # base URL from which the finished HTML is served. stephan@139: #html_use_opensearch = '' stephan@139: stephan@139: # This is the file name suffix for HTML files (e.g. ".xhtml"). stephan@139: #html_file_suffix = None stephan@139: stephan@139: # Output file base name for HTML help builder. stephan@139: htmlhelp_basename = 'MXD2mapdoc' stephan@139: stephan@139: stephan@139: # -- Options for LaTeX output -------------------------------------------------- stephan@139: stephan@139: # The paper size ('letter' or 'a4'). stephan@139: #latex_paper_size = 'letter' stephan@139: stephan@139: # The font size ('10pt', '11pt' or '12pt'). stephan@139: #latex_font_size = '10pt' stephan@139: stephan@139: # Grouping the document tree into LaTeX files. List of tuples stephan@139: # (source start file, target name, title, author, documentclass [howto/manual]). stephan@139: latex_documents = [ stephan@139: ('index', 'MXD2map.tex', u'MXD2map Documentation', stephan@139: u'foo bar', 'manual'), stephan@139: ] stephan@139: stephan@139: # The name of an image file (relative to this directory) to place at the top of stephan@139: # the title page. stephan@139: #latex_logo = None stephan@139: stephan@139: # For "manual" documents, if this is true, then toplevel headings are parts, stephan@139: # not chapters. stephan@139: #latex_use_parts = False stephan@139: stephan@139: # If true, show page references after internal links. stephan@139: #latex_show_pagerefs = False stephan@139: stephan@139: # If true, show URL addresses after external links. stephan@139: #latex_show_urls = False stephan@139: stephan@139: # Additional stuff for the LaTeX preamble. stephan@139: #latex_preamble = '' stephan@139: stephan@139: # Documents to append as an appendix to all manuals. stephan@139: #latex_appendices = [] stephan@139: stephan@139: # If false, no module index is generated. stephan@139: #latex_domain_indices = True stephan@139: stephan@139: latex_elements = { stephan@139: 'preamble': r'''\newcommand{\pyHeaderFamily}{\sffamily\bfseries} stephan@139: \fancypagestyle{normal}{ \fancyhf{} stephan@139: \fancyfoot[LE,RO]{{\pyHeaderFamily \thepage}} stephan@139: \fancyfoot[LO]{{\pyHeaderFamily \nouppercase{\rightmark}}} stephan@139: \fancyfoot[RE]{{\pyHeaderFamily \nouppercase{\leftmark}}} stephan@139: \fancyhead[LE,RO]{{\pyHeaderFamily \title, stephan@139: \releasename\space\version}} stephan@139: \renewcommand{\headrulewidth}{0.4pt} stephan@139: \renewcommand{\footrulewidth}{0.4pt} stephan@139: % changes stephan@139: %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}} stephan@139: stephan@139: } stephan@139: ''', stephan@139: 'classoptions': ',oneside', stephan@139: 'babel': '\\usepackage[ngerman,german]{babel}' stephan@139: } stephan@139: stephan@139: stephan@139: # -- Options for manual page output -------------------------------------------- stephan@139: stephan@139: # One entry per manual page. List of tuples stephan@139: # (source start file, name, description, authors, manual section). stephan@139: man_pages = [ stephan@139: ('index', 'mxd2map', u'MXD2map Documentation', stephan@139: [u'foo bar'], 1) stephan@139: ]