381 lines
12 KiB
Python
381 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Python Bindings for EFL Elementary documentation build configuration file, created by
|
|
# sphinx-quickstart on Thu Jun 28 09:21:25 2012.
|
|
#
|
|
# This file is execfile()d with the current directory set to its containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
import sys, os, platform
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
d = "lib.%s-%s-%d.%d" % (
|
|
platform.system().lower(),
|
|
platform.machine(),
|
|
sys.version_info[0],
|
|
sys.version_info[1]
|
|
)
|
|
sys.path.insert(0, os.path.abspath("../build/"+d))
|
|
#sys.path.insert(0, os.path.abspath('../build/lib.linux-i686-3.2'))
|
|
|
|
# Delete any previously imported efl package
|
|
if "efl" in sys.modules:
|
|
del sys.modules["efl"]
|
|
|
|
|
|
# -- General configuration -----------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
needs_sphinx = '1.1'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.coverage',
|
|
]
|
|
|
|
try:
|
|
import gv
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
extensions.append('sphinx.ext.inheritance_diagram')
|
|
graphviz_output_format = "svg" # png (default) or svg
|
|
graphviz_dot_args = ["-Gbgcolor=transparent", "-Ncolor=#4399FF",
|
|
"-Nfontcolor=white", "-Ecolor=blue"]
|
|
|
|
try:
|
|
import sphinxcontrib.youtube
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
extensions.append('sphinxcontrib.youtube')
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The encoding of source files.
|
|
#source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'Python EFL'
|
|
copyright = u'2008-2014, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
# version = 'X.Y'
|
|
# The full version, including alpha/beta/rc tags.
|
|
# release = 'X.Y.Z'
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#language = None
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
# non-false value, then it is used:
|
|
#today = ''
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
#today_fmt = '%B %d, %Y'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build']
|
|
|
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
|
#default_role = None
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
#add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
#add_module_names = True
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
# output. They are ignored by default.
|
|
#show_authors = False
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
#modindex_common_prefix = []
|
|
|
|
# Setting this True will show missing references as warnings.
|
|
#nitpicky = True
|
|
|
|
# nitpick_ignore = [
|
|
# ('py:obj', 'int'),
|
|
# ('py:obj', 'float'),
|
|
# ('py:obj', 'double'),
|
|
# ('py:obj', 'callable'),
|
|
# ('py:obj', 'function'),
|
|
# ('py:obj', 'str'),
|
|
# ('py:exc', 'RuntimeError'),
|
|
# ('py:exc', 'RuntimeWarning'),
|
|
# ('py:exc', 'ValueError'),
|
|
# ('py:exc', 'TypeError'),
|
|
# ('py:obj', 'Evas_Coord (int)'),
|
|
# ('py:obj', 'string'),
|
|
# ('py:obj', 'list'),
|
|
# ('py:class', 'object'),
|
|
# ('py:obj', 'unicode'),
|
|
# ('py:obj', 'bool'),
|
|
# ('py:obj', 'tuple of ints'),
|
|
# ('py:class', 'efl.eo.Eo'),
|
|
# ('py:attr', 'efl.eo.Eo.data'),
|
|
# ('py:obj', 'datetime.date'),
|
|
# ]
|
|
|
|
|
|
# -- Autodoc configuration -----------------------------------------------------
|
|
|
|
autodoc_default_flags = [
|
|
'members',
|
|
'show-inheritance',
|
|
# 'inherited-members',
|
|
# 'undoc-members',
|
|
]
|
|
autoclass_content = "both"
|
|
autodoc_docstring_signature = True
|
|
# autodoc_member_order = "bysource"
|
|
|
|
def setup(app):
|
|
from sphinx.ext.autodoc import cut_lines
|
|
app.connect('autodoc-process-signature', autodoc_process_signature)
|
|
app.connect('autodoc-process-docstring', cut_lines(2, what=['class']))
|
|
|
|
def autodoc_process_signature(app, what, name, obj, options, signature, return_annotation):
|
|
"""Cleanup params: remove the 'self' param and all the cython types"""
|
|
|
|
if what not in ('function', 'method'):
|
|
return
|
|
|
|
params = list()
|
|
for param in (p.strip() for p in signature[1:-1].split(',')):
|
|
if param != 'self':
|
|
params.append(param.rpartition(' ')[2])
|
|
|
|
return ('(%s)' % ', '.join(params), return_annotation)
|
|
|
|
|
|
# -- Options for HTML output ---------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
# html_theme = 'default' # Classic python style
|
|
# html_theme = 'sphinxdoc' # Much modern sphinx style
|
|
# html_theme = 'sphinx13' # The latest one from the sphinx site
|
|
html_theme = 'efldoc' # EFL dark style
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
#html_theme_options = {}
|
|
|
|
# Add any paths that contain custom themes here, relative to this directory.
|
|
html_theme_path = ['themes']
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
# "<project> v<release> documentation".
|
|
#html_title = None
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
html_short_title = "Python EFL"
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
html_logo = "images/logo.png"
|
|
|
|
# The name of an image file (within the static path) to use as favicon of the
|
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
# pixels large.
|
|
html_favicon = "images/logo.ico"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['images']
|
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
# using the given strftime format.
|
|
html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
# typographically correct entities.
|
|
#html_use_smartypants = True
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
|
#html_sidebars = {}
|
|
|
|
# Additional templates that should be rendered to pages, maps page names to
|
|
# template names.
|
|
#html_additional_pages = {}
|
|
|
|
# If false, no module index is generated.
|
|
#html_domain_indices = True
|
|
|
|
# If false, no index is generated.
|
|
#html_use_index = True
|
|
|
|
# If true, the index is split into individual pages for each letter.
|
|
#html_split_index = False
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
html_show_sourcelink = False
|
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
#html_show_sphinx = True
|
|
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
#html_show_copyright = True
|
|
|
|
# If true, an OpenSearch description file will be output, and all pages will
|
|
# contain a <link> tag referring to it. The value of this option must be the
|
|
# base URL from which the finished HTML is served.
|
|
#html_use_opensearch = ''
|
|
|
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
#html_file_suffix = None
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'PythonEFLdoc'
|
|
|
|
|
|
# -- Options for LaTeX output --------------------------------------------------
|
|
|
|
latex_elements = {
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
#'papersize': 'letterpaper',
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
#'pointsize': '10pt',
|
|
|
|
# Additional stuff for the LaTeX preamble.
|
|
#'preamble': '',
|
|
}
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
|
latex_documents = [
|
|
('index', 'PythonEFL.tex', u'Python Bindings for EFL Documentation',
|
|
u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko', 'manual'),
|
|
]
|
|
|
|
# The name of an image file (relative to this directory) to place at the top of
|
|
# the title page.
|
|
#latex_logo = None
|
|
|
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
# not chapters.
|
|
#latex_use_parts = False
|
|
|
|
# If true, show page references after internal links.
|
|
#latex_show_pagerefs = False
|
|
|
|
# If true, show URL addresses after external links.
|
|
#latex_show_urls = False
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
#latex_appendices = []
|
|
|
|
# If false, no module index is generated.
|
|
#latex_domain_indices = True
|
|
|
|
|
|
# -- Options for manual page output --------------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('index', 'python-efl', u'Python Bindings for EFL Documentation',
|
|
[u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'], 1)
|
|
]
|
|
|
|
# If true, show URL addresses after external links.
|
|
#man_show_urls = False
|
|
|
|
|
|
# -- Options for Texinfo output ------------------------------------------------
|
|
|
|
# Grouping the document tree into Texinfo files. List of tuples
|
|
# (source start file, target name, title, author,
|
|
# dir menu entry, description, category)
|
|
texinfo_documents = [
|
|
('index', 'PythonBindingsforEFLElementary', u'Python Bindings for EFL Elementary Documentation',
|
|
u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko', 'PythonBindingsforEFLElementary', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
#texinfo_appendices = []
|
|
|
|
# If false, no module index is generated.
|
|
#texinfo_domain_indices = True
|
|
|
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
|
#texinfo_show_urls = 'footnote'
|
|
|
|
|
|
# -- Options for Epub output ---------------------------------------------------
|
|
|
|
# Bibliographic Dublin Core info.
|
|
epub_title = u'Python Bindings for EFL'
|
|
epub_author = u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'
|
|
epub_publisher = u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'
|
|
epub_copyright = u'2008-2014, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'
|
|
|
|
# The language of the text. It defaults to the language option
|
|
# or en if the language is not set.
|
|
#epub_language = ''
|
|
|
|
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
|
#epub_scheme = ''
|
|
|
|
# The unique identifier of the text. This can be a ISBN number
|
|
# or the project homepage.
|
|
#epub_identifier = ''
|
|
|
|
# A unique identification for the text.
|
|
#epub_uid = ''
|
|
|
|
# A tuple containing the cover image and cover page html template filenames.
|
|
#epub_cover = ()
|
|
|
|
# HTML files that should be inserted before the pages created by sphinx.
|
|
# The format is a list of tuples containing the path and title.
|
|
#epub_pre_files = []
|
|
|
|
# HTML files shat should be inserted after the pages created by sphinx.
|
|
# The format is a list of tuples containing the path and title.
|
|
#epub_post_files = []
|
|
|
|
# A list of files that should not be packed into the epub file.
|
|
#epub_exclude_files = []
|
|
|
|
# The depth of the table of contents in toc.ncx.
|
|
#epub_tocdepth = 3
|
|
|
|
# Allow duplicate toc entries.
|
|
#epub_tocdup = True
|