• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# -*- coding: utf-8 -*-
2#
3# altgraph documentation build configuration file, created by
4# sphinx-quickstart on Tue Aug 31 11:04:49 2010.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
14import sys, os
15
16def get_version():
17    fn = os.path.join(
18            os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
19            'setup.cfg')
20    for ln in open(fn):
21        if ln.startswith('version'):
22            version = ln.split('=')[-1].strip()
23            return version
24
25# If extensions (or modules to document with autodoc) are in another directory,
26# add these directories to sys.path here. If the directory is relative to the
27# documentation root, use os.path.abspath to make it absolute, like shown here.
28#sys.path.append(os.path.abspath('.'))
29sys.path.insert(0,
30        os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
31
32# -- General configuration -----------------------------------------------------
33
34# Add any Sphinx extension module names here, as strings. They can be extensions
35# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
36extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.autodoc' ]
37
38# Add any paths that contain templates here, relative to this directory.
39templates_path = ['_templates']
40
41# The suffix of source filenames.
42source_suffix = '.rst'
43
44# The encoding of source files.
45#source_encoding = 'utf-8'
46
47# The master toctree document.
48master_doc = 'index'
49
50# General information about the project.
51project = u'altgraph'
52copyright = u'2010-2011, Ronald Oussoren, Bob Ippolito, 2004 Istvan Albert'
53
54# The version info for the project you're documenting, acts as replacement for
55# |version| and |release|, also used in various other places throughout the
56# built documents.
57#
58# The short X.Y version.
59version = get_version()
60# The full version, including alpha/beta/rc tags.
61release = version
62
63# The language for content autogenerated by Sphinx. Refer to documentation
64# for a list of supported languages.
65#language = None
66
67# There are two options for replacing |today|: either, you set today to some
68# non-false value, then it is used:
69#today = ''
70# Else, today_fmt is used as the format for a strftime call.
71#today_fmt = '%B %d, %Y'
72
73# List of documents that shouldn't be included in the build.
74#unused_docs = []
75
76# List of directories, relative to source directory, that shouldn't be searched
77# for source files.
78exclude_trees = ['_build']
79
80# The reST default role (used for this markup: `text`) to use for all documents.
81#default_role = None
82
83# If true, '()' will be appended to :func: etc. cross-reference text.
84#add_function_parentheses = True
85
86# If true, the current module name will be prepended to all description
87# unit titles (such as .. function::).
88#add_module_names = True
89
90# If true, sectionauthor and moduleauthor directives will be shown in the
91# output. They are ignored by default.
92#show_authors = False
93
94# The name of the Pygments (syntax highlighting) style to use.
95pygments_style = 'sphinx'
96
97# A list of ignored prefixes for module index sorting.
98#modindex_common_prefix = []
99
100
101# -- Options for HTML output ---------------------------------------------------
102
103# The theme to use for HTML and HTML Help pages.  Major themes that come with
104# Sphinx are currently 'default' and 'sphinxdoc'.
105html_theme = 'nature'
106
107# Theme options are theme-specific and customize the look and feel of a theme
108# further.  For a list of options available for each theme, see the
109# documentation.
110#html_theme_options = {}
111
112# Add any paths that contain custom themes here, relative to this directory.
113#html_theme_path = []
114
115# The name for this set of Sphinx documents.  If None, it defaults to
116# "<project> v<release> documentation".
117#html_title = None
118
119# A shorter title for the navigation bar.  Default is the same as html_title.
120#html_short_title = None
121
122# The name of an image file (relative to this directory) to place at the top
123# of the sidebar.
124#html_logo = None
125
126# The name of an image file (within the static path) to use as favicon of the
127# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
128# pixels large.
129#html_favicon = None
130
131# Add any paths that contain custom static files (such as style sheets) here,
132# relative to this directory. They are copied after the builtin static files,
133# so a file named "default.css" will overwrite the builtin "default.css".
134html_static_path = ['_static']
135
136# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
137# using the given strftime format.
138#html_last_updated_fmt = '%b %d, %Y'
139
140# If true, SmartyPants will be used to convert quotes and dashes to
141# typographically correct entities.
142#html_use_smartypants = True
143
144# Custom sidebar templates, maps document names to template names.
145#html_sidebars = {}
146
147# Additional templates that should be rendered to pages, maps page names to
148# template names.
149#html_additional_pages = {}
150
151# If false, no module index is generated.
152#html_use_modindex = True
153
154# If false, no index is generated.
155#html_use_index = True
156
157# If true, the index is split into individual pages for each letter.
158#html_split_index = False
159
160# If true, links to the reST sources are added to the pages.
161html_show_sourcelink = False
162
163# If true, an OpenSearch description file will be output, and all pages will
164# contain a <link> tag referring to it.  The value of this option must be the
165# base URL from which the finished HTML is served.
166#html_use_opensearch = ''
167
168# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
169#html_file_suffix = ''
170
171# Output file base name for HTML help builder.
172htmlhelp_basename = 'altgraphdoc'
173
174
175# -- Options for LaTeX output --------------------------------------------------
176
177# The paper size ('letter' or 'a4').
178#latex_paper_size = 'letter'
179
180# The font size ('10pt', '11pt' or '12pt').
181#latex_font_size = '10pt'
182
183# Grouping the document tree into LaTeX files. List of tuples
184# (source start file, target name, title, author, documentclass [howto/manual]).
185latex_documents = [
186  ('index', 'altgraph.tex', u'altgraph Documentation',
187   u'Ronald Oussoren', 'manual'),
188]
189
190# The name of an image file (relative to this directory) to place at the top of
191# the title page.
192#latex_logo = None
193
194# For "manual" documents, if this is true, then toplevel headings are parts,
195# not chapters.
196#latex_use_parts = False
197
198# Additional stuff for the LaTeX preamble.
199#latex_preamble = ''
200
201# Documents to append as an appendix to all manuals.
202#latex_appendices = []
203
204# If false, no module index is generated.
205#latex_use_modindex = True
206
207
208# Example configuration for intersphinx: refer to the Python standard library.
209intersphinx_mapping = {'python': ('http://docs.python.org/', None) }
210