Added first basic documentation rst pages

Author: PierreRaybaut

.gitignore

@@ -1,6 +1,7 @@
 .spyderproject
 qwt-6.1.2
 qwt/tests/demo.png
+qwtdoc.chm
 
 # Created by https://www.gitignore.io/api/python
 

build_chm.bat

@@ -0,0 +1,6 @@
+sphinx-build -b htmlhelp doc doctmp
+"C:\Program Files\HTML Help Workshop\hhc.exe" doctmp\qwtdoc.hhp
+"C:\Program Files (x86)\HTML Help Workshop\hhc.exe" doctmp\qwtdoc.hhp
+copy doctmp\qwtdoc.chm .
+rmdir /S /Q doctmp
+pause

build_doc_zip.bat

@@ -0,0 +1,5 @@
+sphinx-build -b html doc doctmp
+cd doctmp
+7z a -r ..\doc.zip *.*
+cd ..
+rmdir /S /Q doctmp

doc/conf.py

@@ -0,0 +1,201 @@
+# -*- coding: utf-8 -*-
+#
+# 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.
+
+from __future__ import print_function, unicode_literals
+
+import sys
+
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# 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']
+try:
+    import sphinx.ext.viewcode
+    extensions.append('sphinx.ext.viewcode')
+except ImportError:
+    print("WARNING: the Sphinx viewcode extension was not found", file=sys.stderr)
+
+# 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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'python-qwt'
+import time
+this_year = time.strftime("%Y", time.localtime())
+copyright = "2002 Uwe Rathmann (for the original C++ code/doc), 2015 Pierre Raybaut (for the Python translation/optimization/doc adaptation)"
+
+# 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.
+import qwt
+version = ".".join(qwt.__version__.split('.')[:2])
+# The full version, including alpha/beta/rc tags.
+release = qwt.__version__
+
+# 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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# 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 = ['qwt.']
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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 = {'sidebarbgcolor': '#227A2B',
+##                       'sidebarlinkcolor': '#98ff99'}
+
+# 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 = 'images/qwt.png'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = 'favicon.ico'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'qwtdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'qwt.tex', 'python-qwt Documentation', 'Pierre Raybaut', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True

doc/index.rst

@@ -0,0 +1,17 @@
+.. automodule:: qwt
+
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+    
+    overview
+    installation
+    reference
+    
+
+Indices and tables:
+
+* :ref:`genindex`
+* :ref:`search`

doc/installation.rst

@@ -0,0 +1,26 @@
+Installation
+============
+
+Dependencies
+------------
+
+Requirements:
+    * Python 2.x (x>=6)
+    * PyQt4 4.x (x>=4) or PyQt5 5.x (x>=5)
+    * NumPy 1.x (x>=5)
+
+Installation
+------------
+
+From the source package:
+
+    `python setup.py install`
+
+Help and support
+----------------
+
+External resources:
+
+    * Bug reports and feature requests: `GitHub`_
+
+.. _GitHub: https://github.com/PierreRaybaut/python-qwt

doc/overview.rst

@@ -0,0 +1,37 @@
+Purpose and Motivation
+======================
+
+The ``python-qwt`` project was initiated to solve -at least temporarily-
+the obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library)
+which is no longer maintained. The idea was to translate the original
+Qwt C++ code to Python and then to optimize some parts of the code by
+writing new modules based on NumPy and other libraries.
+
+The ``python-qwt`` package consists of a single Python package named
+`qwt` and of a few other files (examples, doc, ...).
+
+Overview
+========
+
+The `qwt` package is a pure Python implementation of `Qwt` C++ library 
+with the following limitations.
+
+The following `Qwt` classes won't be reimplemented in `qwt` because more
+powerful features already exist in `guiqwt`: `QwtPlotZoomer`, 
+`QwtCounter`, `QwtEventPattern`, `QwtPicker`, `QwtPlotPicker`.
+
+Only the following plot items are currently implemented in `qwt` (the 
+only plot items needed by `guiqwt`): `QwtPlotItem` (base class), 
+`QwtPlotItem`, `QwtPlotMarker`, `QwtPlotSeriesItem`, `QwtPlotHistogram`, 
+`QwtPlotCurve`.
+
+The `QwtClipper` class is not implemented yet (and it will probably be 
+very difficult or even impossible to implement it in pure Python without 
+performance issues). As a consequence, when zooming in a plot curve, the 
+entire curve is still painted (in other words, when working with large 
+amount of data, there is no performance gain when zooming in).
+
+Other API compatibility issues with `Qwt`:
+- `QwtPlot.MinimizeMemory` option was removed as this option has no sense 
+  in python-qwt (the polyline plotting is not taking more memory than the 
+  array data that is already there).

doc/reference.rst

@@ -0,0 +1,6 @@
+python-qwt reference
+====================
+
+.. automodule:: qwt.color_map
+   :members:
+   :inherited-members:

qwt/clipper.py

@@ -5,6 +5,8 @@
 # Copyright (c) 2015 Pierre Raybaut, for the Python translation/optimization
 # (see LICENSE file for more details)
 
+#XXX: Unfinished (and not imported elsewhere) translation of QwtClipper class
+
 from qwt.qt.QtGui import QPolygon, QPolygonF
 from qwt.qt.QtCore import QRect, QRectF