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