1# -*- coding: utf-8 -*- 2# 3# GtkAda documentation build configuration file, created by 4# sphinx-quickstart on Thu Dec 8 15:31:22 2011. 5# 6# This file is execfile()d with the current directory set to its containing 7# dir. 8# 9# Note that not all possible configuration values are present in this 10# autogenerated file. 11# 12# All configuration values have a default; values that are commented out 13# serve to show the default. 14 15import sys 16import os 17import time 18 19# If extensions (or modules to document with autodoc) are in another directory, 20# add these directories to sys.path here. If the directory is relative to the 21# documentation root, use os.path.abspath to make it absolute, like shown here. 22# sys.path.insert(0, os.path.abspath('.')) 23 24# -- General configuration ---------------------------------------------------- 25 26# If your documentation needs a minimal Sphinx version, state it here. 27# needs_sphinx = '1.0' 28 29# Add any Sphinx extension module names here, as strings. They can be 30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 31extensions = [] 32 33# Add any paths that contain templates here, relative to this directory. 34templates_path = ['_templates'] 35 36# The suffix of source filenames. 37source_suffix = '.rst' 38 39# The encoding of source files. 40# source_encoding = 'utf-8-sig' 41 42# The master toctree document. 43master_doc = 'index' 44 45 46def get_copyright(): 47 return u'2000-%s, AdaCore' % time.strftime("%Y") 48 49# General information about the project. 50project = u'GtkAda' 51copyright = get_copyright() 52 53 54def get_version(): 55 for line in open("../../configure.in").readlines(): 56 if line.startswith("AC_INIT"): 57 return line.split(",")[1] 58 raise Exception("Cannot find version number") 59 60# The version info for the project you're documenting, acts as replacement for 61# |version| and |release|, also used in various other places throughout the 62# built documents. 63# 64# The short X.Y version. 65version = get_version() 66# The full version, including alpha/beta/rc tags. 67release = version 68 69# The language for content autogenerated by Sphinx. Refer to documentation 70# for a list of supported languages. 71# language = None 72 73# There are two options for replacing |today|: either, you set today to some 74# non-false value, then it is used: 75# today = '' 76# Else, today_fmt is used as the format for a strftime call. 77# today_fmt = '%B %d, %Y' 78 79# List of patterns, relative to source directory, that match files and 80# directories to ignore when looking for source files. 81exclude_patterns = ['_build'] 82 83# The reST default role (used for this markup: `text`) to use for all 84# documents. 85# default_role = None 86 87# If true, '()' will be appended to :func: etc. cross-reference text. 88# add_function_parentheses = True 89 90# If true, the current module name will be prepended to all description 91# unit titles (such as .. function::). 92# add_module_names = True 93 94# If true, sectionauthor and moduleauthor directives will be shown in the 95# output. They are ignored by default. 96# show_authors = False 97 98# The name of the Pygments (syntax highlighting) style to use. 99pygments_style = 'sphinx' 100 101# A list of ignored prefixes for module index sorting. 102# modindex_common_prefix = [] 103 104 105# -- Options for HTML output -------------------------------------------------- 106 107# The theme to use for HTML and HTML Help pages. See the documentation for 108# a list of builtin themes. 109html_theme = 'sphinxdoc' 110 111# Theme options are theme-specific and customize the look and feel of a theme 112# further. For a list of options available for each theme, see the 113# documentation. 114# html_theme_options = {} 115 116# Add any paths that contain custom themes here, relative to this directory. 117# html_theme_path = [] 118 119# The name for this set of Sphinx documents. If None, it defaults to 120# "<project> v<release> documentation". 121# html_title = None 122 123# A shorter title for the navigation bar. Default is the same as html_title. 124# html_short_title = None 125 126# The name of an image file (relative to this directory) to place at the top 127# of the sidebar. 128html_logo = 'adacore_transparent.png' 129 130# The name of an image file (within the static path) to use as favicon of the 131# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 132# pixels large. 133html_favicon = 'favicon.ico' 134 135# Add any paths that contain custom static files (such as style sheets) here, 136# relative to this directory. They are copied after the builtin static files, 137# so a file named "default.css" will overwrite the builtin "default.css". 138html_static_path = ['_static'] 139 140# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 141# using the given strftime format. 142# html_last_updated_fmt = '%b %d, %Y' 143 144# If true, SmartyPants will be used to convert quotes and dashes to 145# typographically correct entities. 146# html_use_smartypants = True 147 148# Custom sidebar templates, maps document names to template names. 149# html_sidebars = {} 150 151# Additional templates that should be rendered to pages, maps page names to 152# template names. 153# html_additional_pages = {} 154 155# If false, no module index is generated. 156# html_domain_indices = True 157 158# If false, no index is generated. 159# html_use_index = True 160 161# If true, the index is split into individual pages for each letter. 162# html_split_index = False 163 164# If true, links to the reST sources are added to the pages. 165# html_show_sourcelink = True 166 167# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 168# html_show_sphinx = True 169 170# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 171# html_show_copyright = True 172 173# If true, an OpenSearch description file will be output, and all pages will 174# contain a <link> tag referring to it. The value of this option must be the 175# base URL from which the finished HTML is served. 176# html_use_opensearch = '' 177 178# This is the file name suffix for HTML files (e.g. ".xhtml"). 179# html_file_suffix = None 180 181# Output file base name for HTML help builder. 182htmlhelp_basename = 'GtkAdadoc' 183 184# -- Options for LaTeX output ------------------------------------------------- 185 186# The paper size ('letter' or 'a4'). 187# latex_paper_size = 'letter' 188 189# The font size ('10pt', '11pt' or '12pt'). 190# latex_font_size = '10pt' 191 192# Grouping the document tree into LaTeX files. List of tuples 193# (source start file, target name, title, author, documentclass [howto/manual]) 194latex_documents = [ 195 ('index', 'GtkAda.tex', u'GtkAda Documentation', 196 u'AdaCore', 'manual'), 197] 198 199# The name of an image file (relative to this directory) to place at the top of 200# the title page. 201# latex_logo = None 202 203# For "manual" documents, if this is true, then toplevel headings are parts, 204# not chapters. 205# latex_use_parts = False 206 207# If true, show page references after internal links. 208# latex_show_pagerefs = False 209 210# If true, show URL addresses after external links. 211# latex_show_urls = False 212 213# Additional stuff for the LaTeX preamble. 214# latex_preamble = '' 215 216# Documents to append as an appendix to all manuals. 217# latex_appendices = [] 218 219# If false, no module index is generated. 220# latex_domain_indices = True 221 222# -- Options for manual page output ------------------------------------------- 223 224# One entry per manual page. List of tuples 225# (source start file, name, description, authors, manual section). 226man_pages = [ 227 ('index', 'gtkada', u'GtkAda Documentation', 228 [u'AdaCore'], 1) 229] 230 231# -- Options for Epub output -------------------------------------------------- 232 233# Bibliographic Dublin Core info. 234epub_title = u'GtkAda' 235epub_author = u'AdaCore' 236epub_publisher = u'AdaCore' 237epub_copyright = copyright 238 239# The language of the text. It defaults to the language option 240# or en if the language is not set. 241# epub_language = '' 242 243# The scheme of the identifier. Typical schemes are ISBN or URL. 244# epub_scheme = '' 245 246# The unique identifier of the text. This can be a ISBN number 247# or the project homepage. 248# epub_identifier = '' 249 250# A unique identification for the text. 251# epub_uid = '' 252 253# HTML files that should be inserted before the pages created by sphinx. 254# The format is a list of tuples containing the path and title. 255# epub_pre_files = [] 256 257# HTML files shat should be inserted after the pages created by sphinx. 258# The format is a list of tuples containing the path and title. 259# epub_post_files = [] 260 261# A list of files that should not be packed into the epub file. 262# epub_exclude_files = [] 263 264# The depth of the table of contents in toc.ncx. 265# epub_tocdepth = 3 266 267# Allow duplicate toc entries. 268# epub_tocdup = True 269