python-efl: Add Sphinx documentation files.
SVN revision: 84096
This commit is contained in:
parent
1e953366b5
commit
743a747a30
|
@ -0,0 +1,153 @@
|
||||||
|
# Makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
PAPER =
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Internal variables.
|
||||||
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||||
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||||||
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
# the i18n builder cannot share the environment and doctrees with the others
|
||||||
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
|
||||||
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||||
|
|
||||||
|
help:
|
||||||
|
@echo "Please use \`make <target>' where <target> is one of"
|
||||||
|
@echo " html to make standalone HTML files"
|
||||||
|
@echo " dirhtml to make HTML files named index.html in directories"
|
||||||
|
@echo " singlehtml to make a single large HTML file"
|
||||||
|
@echo " pickle to make pickle files"
|
||||||
|
@echo " json to make JSON files"
|
||||||
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||||
|
@echo " qthelp to make HTML files and a qthelp project"
|
||||||
|
@echo " devhelp to make HTML files and a Devhelp project"
|
||||||
|
@echo " epub to make an epub"
|
||||||
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
@echo " text to make text files"
|
||||||
|
@echo " man to make manual pages"
|
||||||
|
@echo " texinfo to make Texinfo files"
|
||||||
|
@echo " info to make Texinfo files and run them through makeinfo"
|
||||||
|
@echo " gettext to make PO message catalogs"
|
||||||
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||||
|
@echo " linkcheck to check all external links for integrity"
|
||||||
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
|
||||||
|
clean:
|
||||||
|
-rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
|
html:
|
||||||
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
|
dirhtml:
|
||||||
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
|
singlehtml:
|
||||||
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
|
pickle:
|
||||||
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the pickle files."
|
||||||
|
|
||||||
|
json:
|
||||||
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
|
htmlhelp:
|
||||||
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
|
|
||||||
|
qthelp:
|
||||||
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||||
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||||
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonBindingsforEnlightenmentFoundationLibraries.qhcp"
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonBindingsforEnlightenmentFoundationLibraries.qhc"
|
||||||
|
|
||||||
|
devhelp:
|
||||||
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished."
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/PythonBindingsforEnlightenmentFoundationLibraries"
|
||||||
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonBindingsforEnlightenmentFoundationLibraries"
|
||||||
|
@echo "# devhelp"
|
||||||
|
|
||||||
|
epub:
|
||||||
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
|
latex:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||||
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||||
|
"(use \`make latexpdf' here to do that automatically)."
|
||||||
|
|
||||||
|
latexpdf:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through pdflatex..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
text:
|
||||||
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||||
|
|
||||||
|
man:
|
||||||
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||||
|
|
||||||
|
texinfo:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||||
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||||
|
"(use \`make info' here to do that automatically)."
|
||||||
|
|
||||||
|
info:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo "Running Texinfo files through makeinfo..."
|
||||||
|
make -C $(BUILDDIR)/texinfo info
|
||||||
|
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||||
|
|
||||||
|
gettext:
|
||||||
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||||
|
|
||||||
|
changes:
|
||||||
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||||
|
@echo
|
||||||
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||||
|
|
||||||
|
linkcheck:
|
||||||
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||||
|
@echo
|
||||||
|
@echo "Link check complete; look for any errors in the above output " \
|
||||||
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||||
|
|
||||||
|
doctest:
|
||||||
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/doctest/output.txt."
|
|
@ -0,0 +1,294 @@
|
||||||
|
# -*- 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
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
sys.path.insert(0, os.path.abspath('../build/lib.linux-i686-2.7'))
|
||||||
|
#sys.path.insert(0, os.path.abspath('../build/lib.linux-i686-3.2'))
|
||||||
|
|
||||||
|
# -- General configuration -----------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
#needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# 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.viewcode']
|
||||||
|
|
||||||
|
autodoc_default_flags = [
|
||||||
|
'members',
|
||||||
|
#'inherited-members',
|
||||||
|
'show-inheritance'
|
||||||
|
]
|
||||||
|
autoclass_content = "both"
|
||||||
|
autodoc_docstring_signature = True
|
||||||
|
|
||||||
|
# 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 Bindings for EFL Elementary'
|
||||||
|
copyright = u'2012, 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 = '1.7.0'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '1.7.0'
|
||||||
|
|
||||||
|
# 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 = []
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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 = 'sphinxdoc'
|
||||||
|
|
||||||
|
# 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 = []
|
||||||
|
|
||||||
|
# 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 = None
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
#html_logo = None
|
||||||
|
|
||||||
|
# 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 = None
|
||||||
|
|
||||||
|
# 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 = ['_static']
|
||||||
|
|
||||||
|
# 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 = True
|
||||||
|
|
||||||
|
# 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 = 'PythonBindingsforEFLElementarydoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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', 'PythonBindingsforEFLElementary.tex', 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', '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', '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'], 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 Elementary'
|
||||||
|
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'2012, 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
|
|
@ -0,0 +1,10 @@
|
||||||
|
efl Package
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
|
module-evas
|
||||||
|
module-ecore
|
||||||
|
module-emotion
|
||||||
|
elementary/elementary
|
||||||
|
|
|
@ -0,0 +1,286 @@
|
||||||
|
:mod:`efl.elementary` Package
|
||||||
|
=============================
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
Logging
|
||||||
|
^^^^^^^
|
||||||
|
|
||||||
|
Py-Elm provides `logging <http://docs.python.org/2/library/logging.html>`_
|
||||||
|
to a Logger called *elementary*. It has a NullHandler by default and
|
||||||
|
doesn't propagate so you need to add handlers to it to get output::
|
||||||
|
|
||||||
|
import logging
|
||||||
|
log_from_an_elm = logging.getLogger("elementary")
|
||||||
|
log_from_an_elm.addHandler(logging.StreamHandler())
|
||||||
|
|
||||||
|
Callbacks
|
||||||
|
^^^^^^^^^
|
||||||
|
|
||||||
|
.. rubric:: Widget callbacks
|
||||||
|
|
||||||
|
Widget callbacks are set with callback_*_add methods which take a callable,
|
||||||
|
and optional args, kwargs as data.
|
||||||
|
|
||||||
|
The callbacks have a signature of either::
|
||||||
|
|
||||||
|
obj, *args, **kwargs
|
||||||
|
|
||||||
|
or::
|
||||||
|
|
||||||
|
obj, event_info, *args, **kwargs
|
||||||
|
|
||||||
|
.. rubric:: Event callbacks
|
||||||
|
|
||||||
|
Event callbacks have signature of::
|
||||||
|
|
||||||
|
object, source_object, event_type, event_info, *args, **kwargs
|
||||||
|
|
||||||
|
C API compatibility
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
All class properties have their respective _get/_set methods defined, for C
|
||||||
|
API compatibility.
|
||||||
|
|
||||||
|
We do not document them nor encourage their use.
|
||||||
|
|
||||||
|
Hello Python Elementary
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Let's create an interactive "Hello World" gui where you can click the ok
|
||||||
|
button to exit::
|
||||||
|
|
||||||
|
import efl.elementary as elm
|
||||||
|
|
||||||
|
def on_done(obj):
|
||||||
|
# quit the mainloop
|
||||||
|
elm.exit()
|
||||||
|
|
||||||
|
class Spam:
|
||||||
|
def __init__(self):
|
||||||
|
# new window - do the usual and give it a name (hello) and title (Hello)
|
||||||
|
win = elm.StandardWindow("hello", "Hello")
|
||||||
|
# when the user clicks "close" on a window there is a request to delete
|
||||||
|
win.callback_delete_request_add(on_done)
|
||||||
|
|
||||||
|
# add a box object - default is vertical. a box holds children in a row,
|
||||||
|
# either horizontally or vertically. nothing more.
|
||||||
|
box = elm.Box(win)
|
||||||
|
# make the box horizontal
|
||||||
|
box.horizontal = True
|
||||||
|
# add object as a resize object for the window (controls window minimum
|
||||||
|
# size as well as gets resized if window is resized)
|
||||||
|
win.resize_object_add(box)
|
||||||
|
box.show()
|
||||||
|
|
||||||
|
# add a label widget, set the text and put it in the pad frame
|
||||||
|
lab = elm.Label(win)
|
||||||
|
# set default text of the label
|
||||||
|
lab.text = "Hello out there world!"
|
||||||
|
# pack the label at the end of the box
|
||||||
|
box.pack_end(lab)
|
||||||
|
lab.show()
|
||||||
|
|
||||||
|
# add an ok button
|
||||||
|
btn = elm.Button(win)
|
||||||
|
# set default text of button to "OK"
|
||||||
|
btn.text = "OK"
|
||||||
|
# pack the button at the end of the box
|
||||||
|
box.pack_end(btn)
|
||||||
|
btn.show()
|
||||||
|
# call on_done when button is clicked
|
||||||
|
btn.callback_clicked_add(on_done)
|
||||||
|
|
||||||
|
# now we are done, show the window
|
||||||
|
win.show()
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
elm.init()
|
||||||
|
food = Spam()
|
||||||
|
# run the mainloop and process events and callbacks
|
||||||
|
elm.run()
|
||||||
|
elm.shutdown()
|
||||||
|
|
||||||
|
What is Elementary?
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Elementary is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
|
||||||
|
applications (yet). Small simple ones with simple needs.
|
||||||
|
|
||||||
|
It is meant to make the programmers work almost brainless but give them lots
|
||||||
|
of flexibility.
|
||||||
|
|
||||||
|
Python Elementary Acknowledgements
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
:Copyright:
|
||||||
|
Python Bindings for EFL Elementary are Copyright (C) 2008-2012 Simon Busch
|
||||||
|
and various contributors (see AUTHORS).
|
||||||
|
|
||||||
|
:License:
|
||||||
|
Python Bindings for EFL Elementary are licensed LGPL-3 (see COPYING).
|
||||||
|
|
||||||
|
:Authors:
|
||||||
|
- `Simon Busch <mailto:morphis@gravedo.de>`_
|
||||||
|
- `Boris 'billiob' Faure <mailto:billiob@gmail.com>`_
|
||||||
|
- `Davide 'DaveMDS' Andreoli <mailto:dave@gurumeditation.it>`_
|
||||||
|
- `Fabiano Fidêncio <mailto:fidencio@profusion.mobi>`_
|
||||||
|
- `Bruno Dilly <mailto:bdilly@profusion.mobi>`_
|
||||||
|
- `Tiago Falcão <mailto:tiago@profusion.mobi>`_
|
||||||
|
- `Joost Albers <mailto:joost.albers@nomadrail.com>`_
|
||||||
|
- `Kai Huuhko <mailto:kai.huuhko@gmail.com>`_
|
||||||
|
|
||||||
|
Elementary Acknowledgements
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
There is a lot that goes into making a widget set, and they don't happen out
|
||||||
|
of nothing. It's like trying to make everyone everywhere happy, regardless
|
||||||
|
of age, gender, race or nationality - and that is really tough. So thanks to
|
||||||
|
people and organizations behind this, as listed below:
|
||||||
|
|
||||||
|
:Copyright:
|
||||||
|
Elementary is Copyright (C) 2008-2012 Carsten Haitzler and various
|
||||||
|
contributors (see AUTHORS).
|
||||||
|
|
||||||
|
:License:
|
||||||
|
Elementary is licensed LGPL-2.1 (see COPYING)
|
||||||
|
|
||||||
|
:Authors:
|
||||||
|
- `Carsten Haitzler <mailto:raster@rasterman.com>`_
|
||||||
|
- `Gustavo Sverzut Barbieri <mailto:barbieri@profusion.mobi>`_
|
||||||
|
- `Cedric Bail <mailto:cedric.bail@free.fr>`_
|
||||||
|
- `Vincent Torri <mailto:vtorri@univ-evry.fr>`_
|
||||||
|
- `Daniel Kolesa <mailto:quaker66@gmail.com>`_
|
||||||
|
- `Jaime Thomas <mailto:avi.thomas@gmail.com>`_
|
||||||
|
- `Swisscom <http://www.swisscom.ch/>`_
|
||||||
|
- `Christopher Michael <mailto:devilhorns@comcast.net>`_
|
||||||
|
- `Marco Trevisan (Treviño) <mailto:mail@3v1n0.net>`_
|
||||||
|
- `Michael Bouchaud <mailto:michael.bouchaud@gmail.com>`_
|
||||||
|
- `Jonathan Atton (Watchwolf) <mailto:jonathan.atton@gmail.com>`_
|
||||||
|
- `Brian Wang <mailto:brian.wang.0721@gmail.com>`_
|
||||||
|
- `Mike Blumenkrantz (discomfitor/zmike) <mailto:michael.blumenkrantz@gmail.com>`_
|
||||||
|
- Samsung Electronics tbd
|
||||||
|
- Samsung SAIT tbd
|
||||||
|
- `Brett Nash <mailto:nash@nash.id.au>`_
|
||||||
|
- `Bruno Dilly <mailto:bdilly@profusion.mobi>`_
|
||||||
|
- `Rafael Fonseca <mailto:rfonseca@profusion.mobi>`_
|
||||||
|
- `Chuneon Park <mailto:hermet@hermet.pe.kr>`_
|
||||||
|
- `Woohyun Jung <mailto:wh0705.jung@samsung.com>`_
|
||||||
|
- `Jaehwan Kim <mailto:jae.hwan.kim@samsung.com>`_
|
||||||
|
- `Wonguk Jeong <mailto:wonguk.jeong@samsung.com>`_
|
||||||
|
- `Leandro A. F. Pereira <mailto:leandro@profusion.mobi>`_
|
||||||
|
- `Helen Fornazier <mailto:helen.fornazier@profusion.mobi>`_
|
||||||
|
- `Gustavo Lima Chaves <mailto:glima@profusion.mobi>`_
|
||||||
|
- `Fabiano Fidêncio <mailto:fidencio@profusion.mobi>`_
|
||||||
|
- `Tiago Falcão <mailto:tiago@profusion.mobi>`_
|
||||||
|
- `Otavio Pontes <mailto:otavio@profusion.mobi>`_
|
||||||
|
- `Viktor Kojouharov <mailto:vkojouharov@gmail.com>`_
|
||||||
|
- `Daniel Juyung Seo (SeoZ) <mailto:juyung.seo@samsung.com>`_ (`alt <mailto:seojuyung2@gmail.com>`_)
|
||||||
|
- `Sangho Park <mailto:sangho.g.park@samsung.com>`_ (`alt <mailto:gouache95@gmail.com>`_)
|
||||||
|
- `Rajeev Ranjan (Rajeev) <mailto:rajeev.r@samsung.com>`_ (`alt <mailto:rajeev.jnnce@gmail.com>`_)
|
||||||
|
- `Seunggyun Kim <mailto:sgyun.kim@samsung.com>`_ (`alt <mailto:tmdrbs@gmail.com>`_)
|
||||||
|
- `Sohyun Kim <mailto:anna1014.kim@samsung.com>`_ (`alt <mailto:sohyun.anna@gmail.com>`_)
|
||||||
|
- `Jihoon Kim <mailto:jihoon48.kim@samsung.com>`_
|
||||||
|
- `Jeonghyun Yun (arosis) <mailto:jh0506.yun@samsung.com>`_
|
||||||
|
- `Tom Hacohen <mailto:tom@stosb.com>`_
|
||||||
|
- `Aharon Hillel <mailto:a.hillel@samsung.com>`_
|
||||||
|
- `Jonathan Atton (Watchwolf) <mailto:jonathan.atton@gmail.com>`_
|
||||||
|
- `Shinwoo Kim <mailto:kimcinoo@gmail.com>`_
|
||||||
|
- `Govindaraju SM <mailto:govi.sm@samsung.com>`_ (`alt <mailto:govism@gmail.com>`_)
|
||||||
|
- `Prince Kumar Dubey <mailto:prince.dubey@samsung.com>`_ (`alt <mailto:prince.dubey@gmail.com>`_)
|
||||||
|
- `Sung W. Park <mailto:sungwoo@gmail.com>`_
|
||||||
|
- `Thierry el Borgi <mailto:thierry@substantiel.fr>`_
|
||||||
|
- `Shilpa Singh <mailto:shilpa.singh@samsung.com>`_ (`alt <mailto:shilpasingh.o@gmail.com>`_)
|
||||||
|
- `Chanwook Jung <mailto:joey.jung@samsung.com>`_
|
||||||
|
- `Hyoyoung Chang <mailto:hyoyoung.chang@samsung.com>`_
|
||||||
|
- `Guillaume "Kuri" Friloux <mailto:guillaume.friloux@asp64.com>`_
|
||||||
|
- `Kim Yunhan <mailto:spbear@gmail.com>`_
|
||||||
|
- `Bluezery <mailto:ohpowel@gmail.com>`_
|
||||||
|
- `Nicolas Aguirre <mailto:aguirre.nicolas@gmail.com>`_
|
||||||
|
- `Sanjeev BA <mailto:iamsanjeev@gmail.com>`_
|
||||||
|
- `Hyunsil Park <mailto:hyunsil.park@samsung.com>`_
|
||||||
|
- `Goun Lee <mailto:gouni.lee@samsung.com>`_
|
||||||
|
- `Mikael Sans <mailto:sans.mikael@gmail.com>`_
|
||||||
|
- `Doyoun Kang <mailto:doyoun.kang@samsung.com>`_
|
||||||
|
- `M.V.K. Sumanth <mailto:sumanth.m@samsung.com>`_ (`alt <mailto:mvksumanth@gmail.com>`_)
|
||||||
|
- `Jérôme Pinot <mailto:ngc891@gmail.com>`_
|
||||||
|
- `Davide Andreoli (davemds) <mailto:dave@gurumeditation.it>`_
|
||||||
|
- `Michal Pakula vel Rutka <mailto:m.pakula@samsung.com>`_
|
||||||
|
|
||||||
|
:Contact: `Enlightenment developer mailing list <mailto:enlightenment-devel@lists.sourceforge.net>`_
|
||||||
|
|
||||||
|
Reference
|
||||||
|
---------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
module-actionslider
|
||||||
|
module-background
|
||||||
|
module-box
|
||||||
|
module-bubble
|
||||||
|
module-button
|
||||||
|
module-calendar
|
||||||
|
module-check
|
||||||
|
module-clock
|
||||||
|
module-colorselector
|
||||||
|
module-configuration
|
||||||
|
module-conformant
|
||||||
|
module-ctxpopup
|
||||||
|
module-datetime
|
||||||
|
module-dayselector
|
||||||
|
module-diskselector
|
||||||
|
module-entry
|
||||||
|
module-fileselector
|
||||||
|
module-fileselector_button
|
||||||
|
module-fileselector_entry
|
||||||
|
module-flip
|
||||||
|
module-flipselector
|
||||||
|
module-frame
|
||||||
|
module-general
|
||||||
|
module-gengrid
|
||||||
|
module-genlist
|
||||||
|
module-gesture_layer
|
||||||
|
module-grid
|
||||||
|
module-hover
|
||||||
|
module-hoversel
|
||||||
|
module-icon
|
||||||
|
module-image
|
||||||
|
module-index
|
||||||
|
module-innerwindow
|
||||||
|
module-label
|
||||||
|
module-layout
|
||||||
|
module-layout_class
|
||||||
|
module-list
|
||||||
|
module-map
|
||||||
|
module-mapbuf
|
||||||
|
module-menu
|
||||||
|
module-multibuttonentry
|
||||||
|
module-naviframe
|
||||||
|
module-need
|
||||||
|
module-notify
|
||||||
|
module-object
|
||||||
|
module-object_item
|
||||||
|
module-panel
|
||||||
|
module-panes
|
||||||
|
module-photo
|
||||||
|
module-photocam
|
||||||
|
module-plug
|
||||||
|
module-popup
|
||||||
|
module-progressbar
|
||||||
|
module-radio
|
||||||
|
module-scroller
|
||||||
|
module-segment_control
|
||||||
|
module-separator
|
||||||
|
module-slider
|
||||||
|
module-slideshow
|
||||||
|
module-spinner
|
||||||
|
module-table
|
||||||
|
module-theme
|
||||||
|
module-thumb
|
||||||
|
module-toolbar
|
||||||
|
module-transit
|
||||||
|
module-video
|
||||||
|
module-web
|
||||||
|
module-window
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`actionslider` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.actionslider
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`background` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.background
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`box` Module
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.box
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`bubble` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.bubble
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`button` Module
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.button
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`calendar_elm` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.calendar_elm
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`check` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.check
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`clock` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.clock
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`colorselector` Module
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.colorselector
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`configuration` Module
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.configuration
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`conformant` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.conformant
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`ctxpopup` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.ctxpopup
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`datetime_elm` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.datetime_elm
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`dayselector` Module
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.dayselector
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`diskselector` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.diskselector
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`entry` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.entry
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`fileselector` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.fileselector
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`fileselector_button` Module
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.fileselector_button
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`fileselector_entry` Module
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.fileselector_entry
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`flip` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.flip
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`flipselector` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.flipselector
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`frame` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.frame
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`general` Module
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.general
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`gengrid` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.gengrid
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`genlist` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.genlist
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`gesture_layer` Module
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.gesture_layer
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`grid` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.grid
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`hover` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.hover
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`hoversel` Module
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.hoversel
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`icon` Module
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.icon
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`image` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.image
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`index` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.index
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`innerwindow` Module
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.innerwindow
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`label` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.label
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`layout` Module
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.layout
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`layout_class` Module
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.layout_class
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`list` Module
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.list
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`map` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.map
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`mapbuf` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.mapbuf
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`menu` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.menu
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`multibuttonentry` Module
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.multibuttonentry
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`naviframe` Module
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.naviframe
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`need` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.need
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`notify` Module
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.notify
|
|
@ -0,0 +1,5 @@
|
||||||
|
:mod:`object` Module
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.object
|
||||||
|
:inherited-members:
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`object_item` Module
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.object_item
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`panel` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.panel
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`panes` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.panes
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`photo` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.photo
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`photocam` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.photocam
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`plug` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.plug
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`popup` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.popup
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`progressbar` Module
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.progressbar
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`radio` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.radio
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`scroller` Module
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.scroller
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`segment_control` Module
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.segment_control
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`separator` Module
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.separator
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`slider` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.slider
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`slideshow` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.slideshow
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`spinner` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.spinner
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`table` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.table
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`theme` Module
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.theme
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`thumb` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.thumb
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`toolbar` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.toolbar
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`transit` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.transit
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`video` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.video
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`web` Module
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.web
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`window` Module
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.elementary.window
|
|
@ -0,0 +1,23 @@
|
||||||
|
.. Python Bindings for Enlightenment Foundation Libraries documentation master file, created by
|
||||||
|
sphinx-quickstart on Tue Feb 19 11:08:14 2013.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Python Bindings for Enlightenment Foundation Libraries's documentation!
|
||||||
|
==================================================================================
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
efl
|
||||||
|
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
|
@ -0,0 +1,190 @@
|
||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set BUILDDIR=_build
|
||||||
|
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
|
||||||
|
set I18NSPHINXOPTS=%SPHINXOPTS% .
|
||||||
|
if NOT "%PAPER%" == "" (
|
||||||
|
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||||
|
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
if "%1" == "help" (
|
||||||
|
:help
|
||||||
|
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||||
|
echo. html to make standalone HTML files
|
||||||
|
echo. dirhtml to make HTML files named index.html in directories
|
||||||
|
echo. singlehtml to make a single large HTML file
|
||||||
|
echo. pickle to make pickle files
|
||||||
|
echo. json to make JSON files
|
||||||
|
echo. htmlhelp to make HTML files and a HTML help project
|
||||||
|
echo. qthelp to make HTML files and a qthelp project
|
||||||
|
echo. devhelp to make HTML files and a Devhelp project
|
||||||
|
echo. epub to make an epub
|
||||||
|
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||||
|
echo. text to make text files
|
||||||
|
echo. man to make manual pages
|
||||||
|
echo. texinfo to make Texinfo files
|
||||||
|
echo. gettext to make PO message catalogs
|
||||||
|
echo. changes to make an overview over all changed/added/deprecated items
|
||||||
|
echo. linkcheck to check all external links for integrity
|
||||||
|
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "clean" (
|
||||||
|
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||||
|
del /q /s %BUILDDIR%\*
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "html" (
|
||||||
|
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "dirhtml" (
|
||||||
|
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "singlehtml" (
|
||||||
|
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "pickle" (
|
||||||
|
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished; now you can process the pickle files.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "json" (
|
||||||
|
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished; now you can process the JSON files.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "htmlhelp" (
|
||||||
|
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||||
|
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "qthelp" (
|
||||||
|
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||||
|
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||||
|
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PythonBindingsforEnlightenmentFoundationLibraries.qhcp
|
||||||
|
echo.To view the help file:
|
||||||
|
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PythonBindingsforEnlightenmentFoundationLibraries.ghc
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "devhelp" (
|
||||||
|
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "epub" (
|
||||||
|
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "latex" (
|
||||||
|
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "text" (
|
||||||
|
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "man" (
|
||||||
|
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "texinfo" (
|
||||||
|
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "gettext" (
|
||||||
|
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "changes" (
|
||||||
|
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.The overview file is in %BUILDDIR%/changes.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "linkcheck" (
|
||||||
|
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Link check complete; look for any errors in the above output ^
|
||||||
|
or in %BUILDDIR%/linkcheck/output.txt.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "doctest" (
|
||||||
|
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||||
|
if errorlevel 1 exit /b 1
|
||||||
|
echo.
|
||||||
|
echo.Testing of doctests in the sources finished, look at the ^
|
||||||
|
results in %BUILDDIR%/doctest/output.txt.
|
||||||
|
goto end
|
||||||
|
)
|
||||||
|
|
||||||
|
:end
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`efl.ecore` Module
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.ecore
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`efl.emotion` Module
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.emotion
|
|
@ -0,0 +1,4 @@
|
||||||
|
:mod:`efl.evas` Module
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. automodule:: efl.evas
|
15
setup.py
15
setup.py
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import subprocess
|
import subprocess
|
||||||
from distutils.core import setup
|
from distutils.core import setup, Command
|
||||||
from distutils.extension import Extension
|
from distutils.extension import Extension
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
@ -14,12 +14,21 @@ try:
|
||||||
except ImportError:
|
except ImportError:
|
||||||
raise SystemExit("Requires Cython (http://cython.org/)")
|
raise SystemExit("Requires Cython (http://cython.org/)")
|
||||||
|
|
||||||
|
try:
|
||||||
|
from sphinx.setup_command import BuildDoc
|
||||||
|
except ImportError:
|
||||||
|
class BuildDoc(Command):
|
||||||
|
description = "build documentation using sphinx, that must be installed."
|
||||||
|
user_options = []
|
||||||
|
def initialize_options(self): pass
|
||||||
|
def finalize_options(self): pass
|
||||||
|
def run(self): print("Error: sphinx not found")
|
||||||
|
|
||||||
def pkg_config(name, require, min_vers=None):
|
def pkg_config(name, require, min_vers=None):
|
||||||
try:
|
try:
|
||||||
sys.stdout.write("Checking for " + name + ": ")
|
sys.stdout.write("Checking for " + name + ": ")
|
||||||
ver = subprocess.check_output(["pkg-config", "--modversion", require]).decode("utf-8").strip()
|
ver = subprocess.check_output(["pkg-config", "--modversion", require]).decode("utf-8").strip()
|
||||||
if min_vers is not None:
|
if False:#min_vers is not None:
|
||||||
assert 0 == subprocess.call(["pkg-config", "--atleast-version", min_vers, require])
|
assert 0 == subprocess.call(["pkg-config", "--atleast-version", min_vers, require])
|
||||||
cflags = subprocess.check_output(["pkg-config", "--cflags", require]).decode("utf-8").split()
|
cflags = subprocess.check_output(["pkg-config", "--cflags", require]).decode("utf-8").split()
|
||||||
libs = subprocess.check_output(["pkg-config", "--libs", require]).decode("utf-8").split()
|
libs = subprocess.check_output(["pkg-config", "--libs", require]).decode("utf-8").split()
|
||||||
|
@ -178,7 +187,7 @@ if __name__ == "__main__":
|
||||||
description = "Python bindings for the EFL stack",
|
description = "Python bindings for the EFL stack",
|
||||||
license = "GNU Lesser General Public License (LGPL)",
|
license = "GNU Lesser General Public License (LGPL)",
|
||||||
packages = ["efl", "efl.elementary"],
|
packages = ["efl", "efl.elementary"],
|
||||||
cmdclass = {"build_ext": build_ext},
|
cmdclass = {'build_ext': build_ext, 'build_sphinx': BuildDoc, 'build_doc': BuildDoc},
|
||||||
#ext_modules = modules
|
#ext_modules = modules
|
||||||
ext_modules = cythonize(modules, include_path=["include",], compiler_directives={"embedsignature": False}),
|
ext_modules = cythonize(modules, include_path=["include",], compiler_directives={"embedsignature": False}),
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue