davemds pushed a commit to branch master. http://git.enlightenment.org/bindings/python/python-efl.git/commit/?id=a83da00bc7b54677f8b612f83570b99940a5f541
commit a83da00bc7b54677f8b612f83570b99940a5f541 Author: Dave Andreoli <[email protected]> Date: Thu Nov 18 07:02:41 2021 +0100 Docs: cleanup the conf file Regenerate from a fresh sphinx-quickstart --- doc/conf.py | 227 ++++++---------------------------------------------------- doc/index.rst | 22 ++---- 2 files changed, 26 insertions(+), 223 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 3b38782..466a366 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,22 +1,18 @@ # -*- coding: utf-8 -*- # -# Python Bindings for EFL Elementary documentation build configuration file, created by -# sphinx-quickstart on Thu Jun 28 09:21:25 2012. +# Configuration file for the Sphinx documentation builder. # -# 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. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html import sys, os, platform -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. d = "lib.%s-%s-%d.%d" % ( platform.system().lower(), platform.machine(), @@ -31,7 +27,14 @@ if "efl" in sys.modules: del sys.modules["efl"] -# -- General configuration ----------------------------------------------------- +# -- Project information ----------------------------------------------------- + +project = u'Python EFL' +author = 'The Python-EFL community (see AUTHORS)' +copyright = u'2008-2021, ' + author + + +# -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '3.1' @@ -46,88 +49,16 @@ extensions = [ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - # The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Python EFL' -copyright = u'2008-2015, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -# version = 'X.Y' -# The full version, including alpha/beta/rc tags. -# release = 'X.Y.Z' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# master_doc = 'index' # 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 = 'monokai' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# Setting this True will show missing references as warnings. -#nitpicky = True - -# nitpick_ignore = [ -# ('py:obj', 'int'), -# ('py:obj', 'float'), -# ('py:obj', 'double'), -# ('py:obj', 'callable'), -# ('py:obj', 'function'), -# ('py:obj', 'str'), -# ('py:exc', 'RuntimeError'), -# ('py:exc', 'RuntimeWarning'), -# ('py:exc', 'ValueError'), -# ('py:exc', 'TypeError'), -# ('py:obj', 'Evas_Coord (int)'), -# ('py:obj', 'string'), -# ('py:obj', 'list'), -# ('py:class', 'object'), -# ('py:obj', 'unicode'), -# ('py:obj', 'bool'), -# ('py:obj', 'tuple of ints'), -# ('py:class', 'efl.eo.Eo'), -# ('py:attr', 'efl.eo.Eo.data'), -# ('py:obj', 'datetime.date'), -# ] - # -- Autodoc configuration ----------------------------------------------------- @@ -135,10 +66,11 @@ autodoc_default_options = { 'members': True, # show methods for classes 'show-inheritance': True, # show bases class 'member-order': 'alphabetical', # bysource, alphabetical, groupwise - 'special-members': '__init__', # also document the __init__ method 'no-undoc-members': True, # dont show members without docstring 'no-inherited-members': True, # dont show members from parent classes } +# both the class’ and the __init__ method’s docstring are concatenated +autoclass_content = 'both' def setup(app): from sphinx.ext.autodoc import cut_lines @@ -191,10 +123,11 @@ else: # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # +# html_theme = 'alabaster' # Default sphinx theme # html_theme = 'default' # Classic python style # html_theme = 'sphinxdoc' # Much modern sphinx style # html_theme = 'sphinx13' # The latest one from the sphinx site -html_theme = 'efldoc' # EFL dark style +html_theme = 'efldoc' # Our custom EFL dark style # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -268,121 +201,3 @@ html_show_sourcelink = False # Output file base name for HTML help builder. htmlhelp_basename = 'PythonEFLdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'PythonEFL.tex', u'Python Bindings for EFL Documentation', - u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'python-efl', u'Python Bindings for EFL Documentation', - [u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'PythonBindingsforEFLElementary', u'Python Bindings for EFL Elementary Documentation', - u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko', 'PythonBindingsforEFLElementary', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'Python Bindings for EFL' -epub_author = u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko' -epub_publisher = u'Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko' -epub_copyright = u'2008-2015, 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/index.rst b/doc/index.rst index 2708944..5b3d85a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -75,25 +75,13 @@ Acknowledgements ================ :Copyright: - Python Bindings for EFL are Copyright (C) 2008-2015 Simon Busch - and various contributors (see AUTHORS). + 2008-2021 The Python-EFL community (see AUTHORS) :License: - Python Bindings for EFL are licensed LGPL-3 (see COPYING). - -:Authors: - - `Gustavo Sverzut Barbieri <mailto:[email protected]>`_ - - `Simon Busch <mailto:[email protected]>`_ - - `Boris 'billiob' Faure <mailto:[email protected]>`_ - - `Davide 'davemds' Andreoli <mailto:[email protected]>`_ - - `Fabiano Fidêncio <mailto:[email protected]>`_ - - `Bruno Dilly <mailto:[email protected]>`_ - - `Tiago Falcão <mailto:[email protected]>`_ - - `Joost Albers <mailto:[email protected]>`_ - - `Kai Huuhko <mailto:[email protected]>`_ - - `Ulisses Furquim <[email protected]>`_ - -:Contact: `Enlightenment developer mailing list <mailto:[email protected]>`_ + Python Bindings for EFL are licensed LGPL-3 (see COPYING) + +:Contact: + `Enlightenment developer mailing list <mailto:[email protected]>`_ Indices and tables --
