1# -*- coding: utf-8 -*- 2# 3# zope.interface documentation build configuration file, created by 4# sphinx-quickstart on Mon Mar 26 16:31:31 2012. 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# 11import sys, os 12# All configuration values have a default; values that are commented out 13# serve to show the default. 14 15import sys 16import os 17import pkg_resources 18sys.path.append(os.path.abspath('../src')) 19rqmt = pkg_resources.require('zope.interface')[0] 20# Import and document the pure-python versions of things; they tend to have better 21# docstrings and signatures. 22os.environ['PURE_PYTHON'] = '1' 23# If extensions (or modules to document with autodoc) are in another directory, 24# add these directories to sys.path here. If the directory is relative to the 25# documentation root, use os.path.abspath to make it absolute, like shown here. 26#sys.path.insert(0, os.path.abspath('.')) 27 28# -- General configuration ----------------------------------------------------- 29 30# If your documentation needs a minimal Sphinx version, state it here. 31#needs_sphinx = '1.0' 32 33# Add any Sphinx extension module names here, as strings. They can be extensions 34# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 35extensions = [ 36 'sphinx.ext.autodoc', 37 'sphinx.ext.doctest', 38 'sphinx.ext.intersphinx', 39 'sphinx.ext.todo', 40 'sphinx.ext.ifconfig', 41 'sphinx.ext.viewcode', 42 'repoze.sphinx.autointerface', 43] 44 45# Add any paths that contain templates here, relative to this directory. 46templates_path = ['_templates'] 47 48# The suffix of source filenames. 49source_suffix = '.rst' 50 51# The encoding of source files. 52#source_encoding = 'utf-8-sig' 53 54# The master toctree document. 55master_doc = 'index' 56 57# General information about the project. 58project = 'zope.interface' 59copyright = '2012-2017, Zope Foundation contributors' 60 61# The version info for the project you're documenting, acts as replacement for 62# |version| and |release|, also used in various other places throughout the 63# built documents. 64# 65# The short X.Y version. 66version = '%s.%s' % tuple(map(int, rqmt.version.split('.')[:2])) 67# The full version, including alpha/beta/rc tags. 68release = rqmt.version 69 70# The language for content autogenerated by Sphinx. Refer to documentation 71# for a list of supported languages. 72#language = None 73 74# There are two options for replacing |today|: either, you set today to some 75# non-false value, then it is used: 76#today = '' 77# Else, today_fmt is used as the format for a strftime call. 78#today_fmt = '%B %d, %Y' 79 80# List of patterns, relative to source directory, that match files and 81# directories to ignore when looking for source files. 82exclude_patterns = ['_build'] 83 84# The reST default role (used for this markup: `text`) to use for all documents. 85default_role = 'obj' 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 = 'default' 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. 128#html_logo = None 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. 133#html_favicon = None 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 = 'zopeinterfacedoc' 183 184 185# -- Options for LaTeX output -------------------------------------------------- 186 187latex_elements = { 188# The paper size ('letterpaper' or 'a4paper'). 189#'papersize': 'letterpaper', 190 191# The font size ('10pt', '11pt' or '12pt'). 192#'pointsize': '10pt', 193 194# Additional stuff for the LaTeX preamble. 195#'preamble': '', 196} 197 198# pdflatex can't handle Cyrillic out of the box, but xetext/lualatex should be 199# able to cope 200latex_engine = 'lualatex' 201 202# Grouping the document tree into LaTeX files. List of tuples 203# (source start file, target name, title, author, documentclass [howto/manual]). 204latex_documents = [ 205 ('index', 'zopeinterface.tex', 'zope.interface Documentation', 206 'Zope Foundation contributors', 'manual'), 207] 208 209# The name of an image file (relative to this directory) to place at the top of 210# the title page. 211#latex_logo = None 212 213# For "manual" documents, if this is true, then toplevel headings are parts, 214# not chapters. 215#latex_use_parts = False 216 217# If true, show page references after internal links. 218#latex_show_pagerefs = False 219 220# If true, show URL addresses after external links. 221#latex_show_urls = False 222 223# Documents to append as an appendix to all manuals. 224#latex_appendices = [] 225 226# If false, no module index is generated. 227#latex_domain_indices = True 228 229 230# -- Options for manual page output -------------------------------------------- 231 232# One entry per manual page. List of tuples 233# (source start file, name, description, authors, manual section). 234man_pages = [ 235 ('index', 'zopeinterface', 'zope.interface Documentation', 236 ['Zope Foundation contributors'], 1) 237] 238 239# If true, show URL addresses after external links. 240#man_show_urls = False 241 242 243# -- Options for Texinfo output ------------------------------------------------ 244 245# Grouping the document tree into Texinfo files. List of tuples 246# (source start file, target name, title, author, 247# dir menu entry, description, category) 248texinfo_documents = [ 249 ('index', 'zopeinterface', 'zope.interface Documentation', 250 'Zope Foundation contributors', 'zopeinterface', 'One line description of project.', 251 'Miscellaneous'), 252] 253 254# Documents to append as an appendix to all manuals. 255#texinfo_appendices = [] 256 257# If false, no module index is generated. 258#texinfo_domain_indices = True 259 260# How to display URL addresses: 'footnote', 'no', or 'inline'. 261#texinfo_show_urls = 'footnote' 262 263 264# Example configuration for intersphinx: refer to the Python standard library. 265intersphinx_mapping = { 266 'https://docs.python.org/': None, 267 'https://persistent.readthedocs.io/en/latest/': None, 268 'https://btrees.readthedocs.io/en/latest/': None, 269} 270 271# Sphinx 1.8+ prefers this to `autodoc_default_flags`. It's documented that 272# either True or None mean the same thing as just setting the flag, but 273# only None works in 1.8 (True works in 2.0) 274autodoc_default_options = { 275 'members': None, 276 'show-inheritance': None, 277} 278autodoc_member_order = 'bysource' 279autoclass_content = 'both' 280