From 743a747a309be2cce514aa38223ffc206a24d129 Mon Sep 17 00:00:00 2001 From: Kai Huuhko Date: Tue, 19 Feb 2013 09:53:30 +0000 Subject: [PATCH] python-efl: Add Sphinx documentation files. SVN revision: 84096 --- doc/Makefile | 153 +++++++++ doc/conf.py | 294 ++++++++++++++++++ doc/efl.rst | 10 + doc/elementary/elementary.rst | 286 +++++++++++++++++ doc/elementary/module-actionslider.rst | 4 + doc/elementary/module-background.rst | 4 + doc/elementary/module-box.rst | 4 + doc/elementary/module-bubble.rst | 4 + doc/elementary/module-button.rst | 4 + doc/elementary/module-calendar.rst | 4 + doc/elementary/module-check.rst | 4 + doc/elementary/module-clock.rst | 4 + doc/elementary/module-colorselector.rst | 4 + doc/elementary/module-configuration.rst | 4 + doc/elementary/module-conformant.rst | 4 + doc/elementary/module-ctxpopup.rst | 4 + doc/elementary/module-datetime.rst | 4 + doc/elementary/module-dayselector.rst | 4 + doc/elementary/module-diskselector.rst | 4 + doc/elementary/module-entry.rst | 4 + doc/elementary/module-fileselector.rst | 4 + doc/elementary/module-fileselector_button.rst | 4 + doc/elementary/module-fileselector_entry.rst | 4 + doc/elementary/module-flip.rst | 4 + doc/elementary/module-flipselector.rst | 4 + doc/elementary/module-frame.rst | 4 + doc/elementary/module-general.rst | 4 + doc/elementary/module-gengrid.rst | 4 + doc/elementary/module-genlist.rst | 4 + doc/elementary/module-gesture_layer.rst | 4 + doc/elementary/module-grid.rst | 4 + doc/elementary/module-hover.rst | 4 + doc/elementary/module-hoversel.rst | 4 + doc/elementary/module-icon.rst | 4 + doc/elementary/module-image.rst | 4 + doc/elementary/module-index.rst | 4 + doc/elementary/module-innerwindow.rst | 4 + doc/elementary/module-label.rst | 4 + doc/elementary/module-layout.rst | 4 + doc/elementary/module-layout_class.rst | 4 + doc/elementary/module-list.rst | 4 + doc/elementary/module-map.rst | 4 + doc/elementary/module-mapbuf.rst | 4 + doc/elementary/module-menu.rst | 4 + doc/elementary/module-multibuttonentry.rst | 4 + doc/elementary/module-naviframe.rst | 4 + doc/elementary/module-need.rst | 4 + doc/elementary/module-notify.rst | 4 + doc/elementary/module-object.rst | 5 + doc/elementary/module-object_item.rst | 4 + doc/elementary/module-panel.rst | 4 + doc/elementary/module-panes.rst | 4 + doc/elementary/module-photo.rst | 4 + doc/elementary/module-photocam.rst | 4 + doc/elementary/module-plug.rst | 4 + doc/elementary/module-popup.rst | 4 + doc/elementary/module-progressbar.rst | 4 + doc/elementary/module-radio.rst | 4 + doc/elementary/module-scroller.rst | 4 + doc/elementary/module-segment_control.rst | 4 + doc/elementary/module-separator.rst | 4 + doc/elementary/module-slider.rst | 4 + doc/elementary/module-slideshow.rst | 4 + doc/elementary/module-spinner.rst | 4 + doc/elementary/module-table.rst | 4 + doc/elementary/module-theme.rst | 4 + doc/elementary/module-thumb.rst | 4 + doc/elementary/module-toolbar.rst | 4 + doc/elementary/module-transit.rst | 4 + doc/elementary/module-video.rst | 4 + doc/elementary/module-web.rst | 4 + doc/elementary/module-window.rst | 4 + doc/index.rst | 23 ++ doc/make.bat | 190 +++++++++++ doc/module-ecore.rst | 4 + doc/module-emotion.rst | 4 + doc/module-evas.rst | 4 + setup.py | 15 +- 78 files changed, 1253 insertions(+), 3 deletions(-) create mode 100644 doc/Makefile create mode 100644 doc/conf.py create mode 100644 doc/efl.rst create mode 100644 doc/elementary/elementary.rst create mode 100644 doc/elementary/module-actionslider.rst create mode 100644 doc/elementary/module-background.rst create mode 100644 doc/elementary/module-box.rst create mode 100644 doc/elementary/module-bubble.rst create mode 100644 doc/elementary/module-button.rst create mode 100644 doc/elementary/module-calendar.rst create mode 100644 doc/elementary/module-check.rst create mode 100644 doc/elementary/module-clock.rst create mode 100644 doc/elementary/module-colorselector.rst create mode 100644 doc/elementary/module-configuration.rst create mode 100644 doc/elementary/module-conformant.rst create mode 100644 doc/elementary/module-ctxpopup.rst create mode 100644 doc/elementary/module-datetime.rst create mode 100644 doc/elementary/module-dayselector.rst create mode 100644 doc/elementary/module-diskselector.rst create mode 100644 doc/elementary/module-entry.rst create mode 100644 doc/elementary/module-fileselector.rst create mode 100644 doc/elementary/module-fileselector_button.rst create mode 100644 doc/elementary/module-fileselector_entry.rst create mode 100644 doc/elementary/module-flip.rst create mode 100644 doc/elementary/module-flipselector.rst create mode 100644 doc/elementary/module-frame.rst create mode 100644 doc/elementary/module-general.rst create mode 100644 doc/elementary/module-gengrid.rst create mode 100644 doc/elementary/module-genlist.rst create mode 100644 doc/elementary/module-gesture_layer.rst create mode 100644 doc/elementary/module-grid.rst create mode 100644 doc/elementary/module-hover.rst create mode 100644 doc/elementary/module-hoversel.rst create mode 100644 doc/elementary/module-icon.rst create mode 100644 doc/elementary/module-image.rst create mode 100644 doc/elementary/module-index.rst create mode 100644 doc/elementary/module-innerwindow.rst create mode 100644 doc/elementary/module-label.rst create mode 100644 doc/elementary/module-layout.rst create mode 100644 doc/elementary/module-layout_class.rst create mode 100644 doc/elementary/module-list.rst create mode 100644 doc/elementary/module-map.rst create mode 100644 doc/elementary/module-mapbuf.rst create mode 100644 doc/elementary/module-menu.rst create mode 100644 doc/elementary/module-multibuttonentry.rst create mode 100644 doc/elementary/module-naviframe.rst create mode 100644 doc/elementary/module-need.rst create mode 100644 doc/elementary/module-notify.rst create mode 100644 doc/elementary/module-object.rst create mode 100644 doc/elementary/module-object_item.rst create mode 100644 doc/elementary/module-panel.rst create mode 100644 doc/elementary/module-panes.rst create mode 100644 doc/elementary/module-photo.rst create mode 100644 doc/elementary/module-photocam.rst create mode 100644 doc/elementary/module-plug.rst create mode 100644 doc/elementary/module-popup.rst create mode 100644 doc/elementary/module-progressbar.rst create mode 100644 doc/elementary/module-radio.rst create mode 100644 doc/elementary/module-scroller.rst create mode 100644 doc/elementary/module-segment_control.rst create mode 100644 doc/elementary/module-separator.rst create mode 100644 doc/elementary/module-slider.rst create mode 100644 doc/elementary/module-slideshow.rst create mode 100644 doc/elementary/module-spinner.rst create mode 100644 doc/elementary/module-table.rst create mode 100644 doc/elementary/module-theme.rst create mode 100644 doc/elementary/module-thumb.rst create mode 100644 doc/elementary/module-toolbar.rst create mode 100644 doc/elementary/module-transit.rst create mode 100644 doc/elementary/module-video.rst create mode 100644 doc/elementary/module-web.rst create mode 100644 doc/elementary/module-window.rst create mode 100644 doc/index.rst create mode 100644 doc/make.bat create mode 100644 doc/module-ecore.rst create mode 100644 doc/module-emotion.rst create mode 100644 doc/module-evas.rst diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..d408f93 --- /dev/null +++ b/doc/Makefile @@ -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 ' where 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." diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..60ed05a --- /dev/null +++ b/doc/conf.py @@ -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 +# " v 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 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 diff --git a/doc/efl.rst b/doc/efl.rst new file mode 100644 index 0000000..a2ebb3e --- /dev/null +++ b/doc/efl.rst @@ -0,0 +1,10 @@ +efl Package +=========== + +.. toctree:: + + module-evas + module-ecore + module-emotion + elementary/elementary + diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst new file mode 100644 index 0000000..ad898d3 --- /dev/null +++ b/doc/elementary/elementary.rst @@ -0,0 +1,286 @@ +:mod:`efl.elementary` Package +============================= + +Features +-------- + +Logging +^^^^^^^ + +Py-Elm provides `logging `_ +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 `_ + - `Boris 'billiob' Faure `_ + - `Davide 'DaveMDS' Andreoli `_ + - `Fabiano Fidêncio `_ + - `Bruno Dilly `_ + - `Tiago Falcão `_ + - `Joost Albers `_ + - `Kai Huuhko `_ + +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 `_ + - `Gustavo Sverzut Barbieri `_ + - `Cedric Bail `_ + - `Vincent Torri `_ + - `Daniel Kolesa `_ + - `Jaime Thomas `_ + - `Swisscom `_ + - `Christopher Michael `_ + - `Marco Trevisan (Treviño) `_ + - `Michael Bouchaud `_ + - `Jonathan Atton (Watchwolf) `_ + - `Brian Wang `_ + - `Mike Blumenkrantz (discomfitor/zmike) `_ + - Samsung Electronics tbd + - Samsung SAIT tbd + - `Brett Nash `_ + - `Bruno Dilly `_ + - `Rafael Fonseca `_ + - `Chuneon Park `_ + - `Woohyun Jung `_ + - `Jaehwan Kim `_ + - `Wonguk Jeong `_ + - `Leandro A. F. Pereira `_ + - `Helen Fornazier `_ + - `Gustavo Lima Chaves `_ + - `Fabiano Fidêncio `_ + - `Tiago Falcão `_ + - `Otavio Pontes `_ + - `Viktor Kojouharov `_ + - `Daniel Juyung Seo (SeoZ) `_ (`alt `_) + - `Sangho Park `_ (`alt `_) + - `Rajeev Ranjan (Rajeev) `_ (`alt `_) + - `Seunggyun Kim `_ (`alt `_) + - `Sohyun Kim `_ (`alt `_) + - `Jihoon Kim `_ + - `Jeonghyun Yun (arosis) `_ + - `Tom Hacohen `_ + - `Aharon Hillel `_ + - `Jonathan Atton (Watchwolf) `_ + - `Shinwoo Kim `_ + - `Govindaraju SM `_ (`alt `_) + - `Prince Kumar Dubey `_ (`alt `_) + - `Sung W. Park `_ + - `Thierry el Borgi `_ + - `Shilpa Singh `_ (`alt `_) + - `Chanwook Jung `_ + - `Hyoyoung Chang `_ + - `Guillaume "Kuri" Friloux `_ + - `Kim Yunhan `_ + - `Bluezery `_ + - `Nicolas Aguirre `_ + - `Sanjeev BA `_ + - `Hyunsil Park `_ + - `Goun Lee `_ + - `Mikael Sans `_ + - `Doyoun Kang `_ + - `M.V.K. Sumanth `_ (`alt `_) + - `Jérôme Pinot `_ + - `Davide Andreoli (davemds) `_ + - `Michal Pakula vel Rutka `_ + +:Contact: `Enlightenment developer mailing list `_ + +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 diff --git a/doc/elementary/module-actionslider.rst b/doc/elementary/module-actionslider.rst new file mode 100644 index 0000000..e9c1f23 --- /dev/null +++ b/doc/elementary/module-actionslider.rst @@ -0,0 +1,4 @@ +:mod:`actionslider` Module +-------------------------- + +.. automodule:: efl.elementary.actionslider diff --git a/doc/elementary/module-background.rst b/doc/elementary/module-background.rst new file mode 100644 index 0000000..aa0edea --- /dev/null +++ b/doc/elementary/module-background.rst @@ -0,0 +1,4 @@ +:mod:`background` Module +------------------------ + +.. automodule:: efl.elementary.background diff --git a/doc/elementary/module-box.rst b/doc/elementary/module-box.rst new file mode 100644 index 0000000..977e48b --- /dev/null +++ b/doc/elementary/module-box.rst @@ -0,0 +1,4 @@ +:mod:`box` Module +----------------- + +.. automodule:: efl.elementary.box diff --git a/doc/elementary/module-bubble.rst b/doc/elementary/module-bubble.rst new file mode 100644 index 0000000..24a29b0 --- /dev/null +++ b/doc/elementary/module-bubble.rst @@ -0,0 +1,4 @@ +:mod:`bubble` Module +------------------------ + +.. automodule:: efl.elementary.bubble diff --git a/doc/elementary/module-button.rst b/doc/elementary/module-button.rst new file mode 100644 index 0000000..9ea255d --- /dev/null +++ b/doc/elementary/module-button.rst @@ -0,0 +1,4 @@ +:mod:`button` Module +-------------------- + +.. automodule:: efl.elementary.button diff --git a/doc/elementary/module-calendar.rst b/doc/elementary/module-calendar.rst new file mode 100644 index 0000000..a360fc4 --- /dev/null +++ b/doc/elementary/module-calendar.rst @@ -0,0 +1,4 @@ +:mod:`calendar_elm` Module +-------------------------- + +.. automodule:: efl.elementary.calendar_elm diff --git a/doc/elementary/module-check.rst b/doc/elementary/module-check.rst new file mode 100644 index 0000000..b86941d --- /dev/null +++ b/doc/elementary/module-check.rst @@ -0,0 +1,4 @@ +:mod:`check` Module +------------------- + +.. automodule:: efl.elementary.check diff --git a/doc/elementary/module-clock.rst b/doc/elementary/module-clock.rst new file mode 100644 index 0000000..766e494 --- /dev/null +++ b/doc/elementary/module-clock.rst @@ -0,0 +1,4 @@ +:mod:`clock` Module +------------------------ + +.. automodule:: efl.elementary.clock diff --git a/doc/elementary/module-colorselector.rst b/doc/elementary/module-colorselector.rst new file mode 100644 index 0000000..95159ad --- /dev/null +++ b/doc/elementary/module-colorselector.rst @@ -0,0 +1,4 @@ +:mod:`colorselector` Module +--------------------------- + +.. automodule:: efl.elementary.colorselector diff --git a/doc/elementary/module-configuration.rst b/doc/elementary/module-configuration.rst new file mode 100644 index 0000000..1e647cf --- /dev/null +++ b/doc/elementary/module-configuration.rst @@ -0,0 +1,4 @@ +:mod:`configuration` Module +--------------------------- + +.. automodule:: efl.elementary.configuration diff --git a/doc/elementary/module-conformant.rst b/doc/elementary/module-conformant.rst new file mode 100644 index 0000000..d572fad --- /dev/null +++ b/doc/elementary/module-conformant.rst @@ -0,0 +1,4 @@ +:mod:`conformant` Module +------------------------ + +.. automodule:: efl.elementary.conformant diff --git a/doc/elementary/module-ctxpopup.rst b/doc/elementary/module-ctxpopup.rst new file mode 100644 index 0000000..147eef9 --- /dev/null +++ b/doc/elementary/module-ctxpopup.rst @@ -0,0 +1,4 @@ +:mod:`ctxpopup` Module +------------------------ + +.. automodule:: efl.elementary.ctxpopup diff --git a/doc/elementary/module-datetime.rst b/doc/elementary/module-datetime.rst new file mode 100644 index 0000000..4fba0cb --- /dev/null +++ b/doc/elementary/module-datetime.rst @@ -0,0 +1,4 @@ +:mod:`datetime_elm` Module +-------------------------- + +.. automodule:: efl.elementary.datetime_elm diff --git a/doc/elementary/module-dayselector.rst b/doc/elementary/module-dayselector.rst new file mode 100644 index 0000000..1624dac --- /dev/null +++ b/doc/elementary/module-dayselector.rst @@ -0,0 +1,4 @@ +:mod:`dayselector` Module +------------------------- + +.. automodule:: efl.elementary.dayselector diff --git a/doc/elementary/module-diskselector.rst b/doc/elementary/module-diskselector.rst new file mode 100644 index 0000000..506c2ea --- /dev/null +++ b/doc/elementary/module-diskselector.rst @@ -0,0 +1,4 @@ +:mod:`diskselector` Module +-------------------------- + +.. automodule:: efl.elementary.diskselector diff --git a/doc/elementary/module-entry.rst b/doc/elementary/module-entry.rst new file mode 100644 index 0000000..2304c5f --- /dev/null +++ b/doc/elementary/module-entry.rst @@ -0,0 +1,4 @@ +:mod:`entry` Module +------------------- + +.. automodule:: efl.elementary.entry diff --git a/doc/elementary/module-fileselector.rst b/doc/elementary/module-fileselector.rst new file mode 100644 index 0000000..1b81172 --- /dev/null +++ b/doc/elementary/module-fileselector.rst @@ -0,0 +1,4 @@ +:mod:`fileselector` Module +-------------------------- + +.. automodule:: efl.elementary.fileselector diff --git a/doc/elementary/module-fileselector_button.rst b/doc/elementary/module-fileselector_button.rst new file mode 100644 index 0000000..9b487a0 --- /dev/null +++ b/doc/elementary/module-fileselector_button.rst @@ -0,0 +1,4 @@ +:mod:`fileselector_button` Module +--------------------------------- + +.. automodule:: efl.elementary.fileselector_button diff --git a/doc/elementary/module-fileselector_entry.rst b/doc/elementary/module-fileselector_entry.rst new file mode 100644 index 0000000..7454910 --- /dev/null +++ b/doc/elementary/module-fileselector_entry.rst @@ -0,0 +1,4 @@ +:mod:`fileselector_entry` Module +-------------------------------- + +.. automodule:: efl.elementary.fileselector_entry diff --git a/doc/elementary/module-flip.rst b/doc/elementary/module-flip.rst new file mode 100644 index 0000000..0bbf07e --- /dev/null +++ b/doc/elementary/module-flip.rst @@ -0,0 +1,4 @@ +:mod:`flip` Module +------------------------ + +.. automodule:: efl.elementary.flip diff --git a/doc/elementary/module-flipselector.rst b/doc/elementary/module-flipselector.rst new file mode 100644 index 0000000..1482600 --- /dev/null +++ b/doc/elementary/module-flipselector.rst @@ -0,0 +1,4 @@ +:mod:`flipselector` Module +-------------------------- + +.. automodule:: efl.elementary.flipselector diff --git a/doc/elementary/module-frame.rst b/doc/elementary/module-frame.rst new file mode 100644 index 0000000..0898247 --- /dev/null +++ b/doc/elementary/module-frame.rst @@ -0,0 +1,4 @@ +:mod:`frame` Module +------------------------ + +.. automodule:: efl.elementary.frame diff --git a/doc/elementary/module-general.rst b/doc/elementary/module-general.rst new file mode 100644 index 0000000..0eb8483 --- /dev/null +++ b/doc/elementary/module-general.rst @@ -0,0 +1,4 @@ +:mod:`general` Module +--------------------- + +.. automodule:: efl.elementary.general diff --git a/doc/elementary/module-gengrid.rst b/doc/elementary/module-gengrid.rst new file mode 100644 index 0000000..26037ee --- /dev/null +++ b/doc/elementary/module-gengrid.rst @@ -0,0 +1,4 @@ +:mod:`gengrid` Module +------------------------ + +.. automodule:: efl.elementary.gengrid diff --git a/doc/elementary/module-genlist.rst b/doc/elementary/module-genlist.rst new file mode 100644 index 0000000..f073f65 --- /dev/null +++ b/doc/elementary/module-genlist.rst @@ -0,0 +1,4 @@ +:mod:`genlist` Module +------------------------ + +.. automodule:: efl.elementary.genlist diff --git a/doc/elementary/module-gesture_layer.rst b/doc/elementary/module-gesture_layer.rst new file mode 100644 index 0000000..d9403b6 --- /dev/null +++ b/doc/elementary/module-gesture_layer.rst @@ -0,0 +1,4 @@ +:mod:`gesture_layer` Module +--------------------------- + +.. automodule:: efl.elementary.gesture_layer diff --git a/doc/elementary/module-grid.rst b/doc/elementary/module-grid.rst new file mode 100644 index 0000000..342faa9 --- /dev/null +++ b/doc/elementary/module-grid.rst @@ -0,0 +1,4 @@ +:mod:`grid` Module +------------------------ + +.. automodule:: efl.elementary.grid diff --git a/doc/elementary/module-hover.rst b/doc/elementary/module-hover.rst new file mode 100644 index 0000000..f8a3cc1 --- /dev/null +++ b/doc/elementary/module-hover.rst @@ -0,0 +1,4 @@ +:mod:`hover` Module +------------------- + +.. automodule:: efl.elementary.hover diff --git a/doc/elementary/module-hoversel.rst b/doc/elementary/module-hoversel.rst new file mode 100644 index 0000000..da7cc49 --- /dev/null +++ b/doc/elementary/module-hoversel.rst @@ -0,0 +1,4 @@ +:mod:`hoversel` Module +---------------------- + +.. automodule:: efl.elementary.hoversel diff --git a/doc/elementary/module-icon.rst b/doc/elementary/module-icon.rst new file mode 100644 index 0000000..885b25f --- /dev/null +++ b/doc/elementary/module-icon.rst @@ -0,0 +1,4 @@ +:mod:`icon` Module +------------------ + +.. automodule:: efl.elementary.icon diff --git a/doc/elementary/module-image.rst b/doc/elementary/module-image.rst new file mode 100644 index 0000000..fcf5e4e --- /dev/null +++ b/doc/elementary/module-image.rst @@ -0,0 +1,4 @@ +:mod:`image` Module +------------------- + +.. automodule:: efl.elementary.image diff --git a/doc/elementary/module-index.rst b/doc/elementary/module-index.rst new file mode 100644 index 0000000..bc45b0c --- /dev/null +++ b/doc/elementary/module-index.rst @@ -0,0 +1,4 @@ +:mod:`index` Module +------------------------ + +.. automodule:: efl.elementary.index diff --git a/doc/elementary/module-innerwindow.rst b/doc/elementary/module-innerwindow.rst new file mode 100644 index 0000000..8afdfec --- /dev/null +++ b/doc/elementary/module-innerwindow.rst @@ -0,0 +1,4 @@ +:mod:`innerwindow` Module +------------------------- + +.. automodule:: efl.elementary.innerwindow diff --git a/doc/elementary/module-label.rst b/doc/elementary/module-label.rst new file mode 100644 index 0000000..52c0a06 --- /dev/null +++ b/doc/elementary/module-label.rst @@ -0,0 +1,4 @@ +:mod:`label` Module +------------------- + +.. automodule:: efl.elementary.label diff --git a/doc/elementary/module-layout.rst b/doc/elementary/module-layout.rst new file mode 100644 index 0000000..d5177b4 --- /dev/null +++ b/doc/elementary/module-layout.rst @@ -0,0 +1,4 @@ +:mod:`layout` Module +-------------------- + +.. automodule:: efl.elementary.layout diff --git a/doc/elementary/module-layout_class.rst b/doc/elementary/module-layout_class.rst new file mode 100644 index 0000000..c08d7ef --- /dev/null +++ b/doc/elementary/module-layout_class.rst @@ -0,0 +1,4 @@ +:mod:`layout_class` Module +-------------------------- + +.. automodule:: efl.elementary.layout_class diff --git a/doc/elementary/module-list.rst b/doc/elementary/module-list.rst new file mode 100644 index 0000000..c12024f --- /dev/null +++ b/doc/elementary/module-list.rst @@ -0,0 +1,4 @@ +:mod:`list` Module +------------------ + +.. automodule:: efl.elementary.list diff --git a/doc/elementary/module-map.rst b/doc/elementary/module-map.rst new file mode 100644 index 0000000..807c4e6 --- /dev/null +++ b/doc/elementary/module-map.rst @@ -0,0 +1,4 @@ +:mod:`map` Module +------------------------ + +.. automodule:: efl.elementary.map diff --git a/doc/elementary/module-mapbuf.rst b/doc/elementary/module-mapbuf.rst new file mode 100644 index 0000000..21eb8be --- /dev/null +++ b/doc/elementary/module-mapbuf.rst @@ -0,0 +1,4 @@ +:mod:`mapbuf` Module +------------------------ + +.. automodule:: efl.elementary.mapbuf diff --git a/doc/elementary/module-menu.rst b/doc/elementary/module-menu.rst new file mode 100644 index 0000000..4d8d8d8 --- /dev/null +++ b/doc/elementary/module-menu.rst @@ -0,0 +1,4 @@ +:mod:`menu` Module +------------------------ + +.. automodule:: efl.elementary.menu diff --git a/doc/elementary/module-multibuttonentry.rst b/doc/elementary/module-multibuttonentry.rst new file mode 100644 index 0000000..fd39be3 --- /dev/null +++ b/doc/elementary/module-multibuttonentry.rst @@ -0,0 +1,4 @@ +:mod:`multibuttonentry` Module +------------------------------ + +.. automodule:: efl.elementary.multibuttonentry diff --git a/doc/elementary/module-naviframe.rst b/doc/elementary/module-naviframe.rst new file mode 100644 index 0000000..1eeaecc --- /dev/null +++ b/doc/elementary/module-naviframe.rst @@ -0,0 +1,4 @@ +:mod:`naviframe` Module +----------------------- + +.. automodule:: efl.elementary.naviframe diff --git a/doc/elementary/module-need.rst b/doc/elementary/module-need.rst new file mode 100644 index 0000000..36d6ff1 --- /dev/null +++ b/doc/elementary/module-need.rst @@ -0,0 +1,4 @@ +:mod:`need` Module +------------------------ + +.. automodule:: efl.elementary.need diff --git a/doc/elementary/module-notify.rst b/doc/elementary/module-notify.rst new file mode 100644 index 0000000..27f500b --- /dev/null +++ b/doc/elementary/module-notify.rst @@ -0,0 +1,4 @@ +:mod:`notify` Module +-------------------- + +.. automodule:: efl.elementary.notify diff --git a/doc/elementary/module-object.rst b/doc/elementary/module-object.rst new file mode 100644 index 0000000..416f9ef --- /dev/null +++ b/doc/elementary/module-object.rst @@ -0,0 +1,5 @@ +:mod:`object` Module +-------------------- + +.. automodule:: efl.elementary.object + :inherited-members: diff --git a/doc/elementary/module-object_item.rst b/doc/elementary/module-object_item.rst new file mode 100644 index 0000000..4b17796 --- /dev/null +++ b/doc/elementary/module-object_item.rst @@ -0,0 +1,4 @@ +:mod:`object_item` Module +------------------------- + +.. automodule:: efl.elementary.object_item diff --git a/doc/elementary/module-panel.rst b/doc/elementary/module-panel.rst new file mode 100644 index 0000000..7f44661 --- /dev/null +++ b/doc/elementary/module-panel.rst @@ -0,0 +1,4 @@ +:mod:`panel` Module +------------------------ + +.. automodule:: efl.elementary.panel diff --git a/doc/elementary/module-panes.rst b/doc/elementary/module-panes.rst new file mode 100644 index 0000000..ed1f284 --- /dev/null +++ b/doc/elementary/module-panes.rst @@ -0,0 +1,4 @@ +:mod:`panes` Module +------------------------ + +.. automodule:: efl.elementary.panes diff --git a/doc/elementary/module-photo.rst b/doc/elementary/module-photo.rst new file mode 100644 index 0000000..c510384 --- /dev/null +++ b/doc/elementary/module-photo.rst @@ -0,0 +1,4 @@ +:mod:`photo` Module +------------------------ + +.. automodule:: efl.elementary.photo diff --git a/doc/elementary/module-photocam.rst b/doc/elementary/module-photocam.rst new file mode 100644 index 0000000..b8b2cf7 --- /dev/null +++ b/doc/elementary/module-photocam.rst @@ -0,0 +1,4 @@ +:mod:`photocam` Module +------------------------ + +.. automodule:: efl.elementary.photocam diff --git a/doc/elementary/module-plug.rst b/doc/elementary/module-plug.rst new file mode 100644 index 0000000..0b5cfdd --- /dev/null +++ b/doc/elementary/module-plug.rst @@ -0,0 +1,4 @@ +:mod:`plug` Module +------------------------ + +.. automodule:: efl.elementary.plug diff --git a/doc/elementary/module-popup.rst b/doc/elementary/module-popup.rst new file mode 100644 index 0000000..2da5160 --- /dev/null +++ b/doc/elementary/module-popup.rst @@ -0,0 +1,4 @@ +:mod:`popup` Module +------------------------ + +.. automodule:: efl.elementary.popup diff --git a/doc/elementary/module-progressbar.rst b/doc/elementary/module-progressbar.rst new file mode 100644 index 0000000..7fdd5d3 --- /dev/null +++ b/doc/elementary/module-progressbar.rst @@ -0,0 +1,4 @@ +:mod:`progressbar` Module +------------------------- + +.. automodule:: efl.elementary.progressbar diff --git a/doc/elementary/module-radio.rst b/doc/elementary/module-radio.rst new file mode 100644 index 0000000..e88205f --- /dev/null +++ b/doc/elementary/module-radio.rst @@ -0,0 +1,4 @@ +:mod:`radio` Module +------------------- + +.. automodule:: efl.elementary.radio diff --git a/doc/elementary/module-scroller.rst b/doc/elementary/module-scroller.rst new file mode 100644 index 0000000..84c6e64 --- /dev/null +++ b/doc/elementary/module-scroller.rst @@ -0,0 +1,4 @@ +:mod:`scroller` Module +---------------------- + +.. automodule:: efl.elementary.scroller diff --git a/doc/elementary/module-segment_control.rst b/doc/elementary/module-segment_control.rst new file mode 100644 index 0000000..7c9ebfe --- /dev/null +++ b/doc/elementary/module-segment_control.rst @@ -0,0 +1,4 @@ +:mod:`segment_control` Module +----------------------------- + +.. automodule:: efl.elementary.segment_control diff --git a/doc/elementary/module-separator.rst b/doc/elementary/module-separator.rst new file mode 100644 index 0000000..7b84365 --- /dev/null +++ b/doc/elementary/module-separator.rst @@ -0,0 +1,4 @@ +:mod:`separator` Module +----------------------- + +.. automodule:: efl.elementary.separator diff --git a/doc/elementary/module-slider.rst b/doc/elementary/module-slider.rst new file mode 100644 index 0000000..5ea5a52 --- /dev/null +++ b/doc/elementary/module-slider.rst @@ -0,0 +1,4 @@ +:mod:`slider` Module +------------------------ + +.. automodule:: efl.elementary.slider diff --git a/doc/elementary/module-slideshow.rst b/doc/elementary/module-slideshow.rst new file mode 100644 index 0000000..4244f36 --- /dev/null +++ b/doc/elementary/module-slideshow.rst @@ -0,0 +1,4 @@ +:mod:`slideshow` Module +------------------------ + +.. automodule:: efl.elementary.slideshow diff --git a/doc/elementary/module-spinner.rst b/doc/elementary/module-spinner.rst new file mode 100644 index 0000000..ece0aee --- /dev/null +++ b/doc/elementary/module-spinner.rst @@ -0,0 +1,4 @@ +:mod:`spinner` Module +------------------------ + +.. automodule:: efl.elementary.spinner diff --git a/doc/elementary/module-table.rst b/doc/elementary/module-table.rst new file mode 100644 index 0000000..33df473 --- /dev/null +++ b/doc/elementary/module-table.rst @@ -0,0 +1,4 @@ +:mod:`table` Module +------------------- + +.. automodule:: efl.elementary.table diff --git a/doc/elementary/module-theme.rst b/doc/elementary/module-theme.rst new file mode 100644 index 0000000..6872250 --- /dev/null +++ b/doc/elementary/module-theme.rst @@ -0,0 +1,4 @@ +:mod:`theme` Module +------------------- + +.. automodule:: efl.elementary.theme diff --git a/doc/elementary/module-thumb.rst b/doc/elementary/module-thumb.rst new file mode 100644 index 0000000..5180e58 --- /dev/null +++ b/doc/elementary/module-thumb.rst @@ -0,0 +1,4 @@ +:mod:`thumb` Module +------------------------ + +.. automodule:: efl.elementary.thumb diff --git a/doc/elementary/module-toolbar.rst b/doc/elementary/module-toolbar.rst new file mode 100644 index 0000000..83a457b --- /dev/null +++ b/doc/elementary/module-toolbar.rst @@ -0,0 +1,4 @@ +:mod:`toolbar` Module +------------------------ + +.. automodule:: efl.elementary.toolbar diff --git a/doc/elementary/module-transit.rst b/doc/elementary/module-transit.rst new file mode 100644 index 0000000..617a9ee --- /dev/null +++ b/doc/elementary/module-transit.rst @@ -0,0 +1,4 @@ +:mod:`transit` Module +------------------------ + +.. automodule:: efl.elementary.transit diff --git a/doc/elementary/module-video.rst b/doc/elementary/module-video.rst new file mode 100644 index 0000000..787fe8c --- /dev/null +++ b/doc/elementary/module-video.rst @@ -0,0 +1,4 @@ +:mod:`video` Module +------------------------ + +.. automodule:: efl.elementary.video diff --git a/doc/elementary/module-web.rst b/doc/elementary/module-web.rst new file mode 100644 index 0000000..bdecb84 --- /dev/null +++ b/doc/elementary/module-web.rst @@ -0,0 +1,4 @@ +:mod:`web` Module +------------------------ + +.. automodule:: efl.elementary.web diff --git a/doc/elementary/module-window.rst b/doc/elementary/module-window.rst new file mode 100644 index 0000000..6391ed4 --- /dev/null +++ b/doc/elementary/module-window.rst @@ -0,0 +1,4 @@ +:mod:`window` Module +-------------------- + +.. automodule:: efl.elementary.window diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..fd3c88c --- /dev/null +++ b/doc/index.rst @@ -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` + diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 0000000..e204d06 --- /dev/null +++ b/doc/make.bat @@ -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 ^` where ^ 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 diff --git a/doc/module-ecore.rst b/doc/module-ecore.rst new file mode 100644 index 0000000..1f7c083 --- /dev/null +++ b/doc/module-ecore.rst @@ -0,0 +1,4 @@ +:mod:`efl.ecore` Module +----------------------- + +.. automodule:: efl.ecore diff --git a/doc/module-emotion.rst b/doc/module-emotion.rst new file mode 100644 index 0000000..db3e89b --- /dev/null +++ b/doc/module-emotion.rst @@ -0,0 +1,4 @@ +:mod:`efl.emotion` Module +------------------------- + +.. automodule:: efl.emotion diff --git a/doc/module-evas.rst b/doc/module-evas.rst new file mode 100644 index 0000000..0c777a2 --- /dev/null +++ b/doc/module-evas.rst @@ -0,0 +1,4 @@ +:mod:`efl.evas` Module +---------------------- + +.. automodule:: efl.evas diff --git a/setup.py b/setup.py index d92f0a6..729d0f5 100755 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ import sys import subprocess -from distutils.core import setup +from distutils.core import setup, Command from distutils.extension import Extension try: @@ -14,12 +14,21 @@ try: except ImportError: 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): try: sys.stdout.write("Checking for " + name + ": ") 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]) cflags = subprocess.check_output(["pkg-config", "--cflags", 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", license = "GNU Lesser General Public License (LGPL)", 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 = cythonize(modules, include_path=["include",], compiler_directives={"embedsignature": False}), )