update index, add composite image

Author: newville

doc/_templates/indexsidebar.html

@@ -8,15 +8,11 @@ <h3>Contents</h3>
    <li>&nbsp; &nbsp;<a href="{{ pathto('imagepanel') }}"> Image API</a></li>
    <li>&nbsp; &nbsp;<a href="{{ pathto('examples') }}">    Examples</a></li>
    <li>&nbsp; &nbsp;<a href="{{ pathto('other') }}"> Speciality Displays</a></li>
+   <li>&nbsp; &nbsp;<a href="{{ pathto('comparisons') }}">Comparisons</a></li>
 </ul>
 <p>
 
 <h3>WXMPLOT</h3>
-<p>Current version: <b>{{ release }}</b></p>
-<p>Install: &nbsp; <b>pip install wxmplot</b>
-<p>Develop:
-  &nbsp; <a href="https://github.com/newville/wxmplot/">github.com</a>
-  <p>
-
-
-<p>
+Current version: {{ release }} <br>
+Install: &nbsp; pip install wxmplot<br>
+Develop: &nbsp; <a href="https://github.com/newville/wxmplot/">github.com</a>

doc/conf.py

@@ -20,30 +20,36 @@
 release = version_parse(wxmplot.__version__).public
 
 html_title = "WXMPLOT: interactive plotting with Python"
-html_short_title = "WXMPLOT: wxPython+matplotlib"
+html_short_title = "WXMPLOT"
 
 # sys.path.append(os.path.abspath(os.path.join('.')))
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
-              'sphinx.ext.napoleon', 'sphinxcontrib.video']
+              'sphinx.ext.napoleon', 'sphinxcontrib.video',
+              'sphinx_copybutton']
 
-autoclass_content = 'both'
+# autoclass_content = 'both'
 templates_path = ['_templates']
 source_suffix = {'.rst': 'restructuredtext'}
-master_doc = 'index'
 
 exclude_trees = ['_build']
 default_role = None
+source_encoding = 'utf-8'
 
 add_function_parentheses = True
-add_module_names = False
+
+add_module_names = True
 pygments_style = 'sphinx'
 
 html_theme_path = ['sphinx_theme']
 html_theme = 'bizstyle'
 
 
 html_static_path = ['_static']
-html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
+html_sidebars = {
+  'index': ["indexsidebar.html",  "sourcelink.html", "searchbox.html"],
+  "**": [ "localtoc.html",  "relations.html", "sourcelink.html", "searchbox.html"]
+}
+
 html_domain_indices = False
 html_use_index = True
 html_show_sourcelink = True

doc/index.rst

@@ -6,36 +6,41 @@ WXMPLOT: plotting widgets for Python
 .. _wxPython: https://www.wxpython.org/
 .. _matplotlib:  https://matplotlib.org/
 
-`wxmplot` provides high-level plotting of numerical data for Python, combining
-`wxPython`_ widgets and `matplotlib`_.
-
-While `matplotlib`_ provides excellent general-purpose plotting functionality
-supporting many backends, it does not have tight integration with any
-particular GUI toolkit.  The `matplotlib.pyplot` module provides high-level
-functions for plotting and displaying data, but interacting with and
-customizing the plots from it Navigation Toolbars are minimal.  On the other
-hand, `wxPython`_ has some basic plotting functionality, but it has nothing as
-good as `matplotlib`_.
-
-`wxmplot` bridges the gap between `matplotlib`_ and `wxPython`_ by providing
-wxPython widgets and user-friendly functions for basic line plots, image
-display, and some custom plots.  The displays made with `wxmplot` give
-end-users highly interactive displays of their data that allow zooming and
-un-zooming, reporting mouse positions, rotating images, and changing color
-themes.  The displays are highly configurable, helping the user to change many
-aspects of the plot such as colors, line types, labels, marker type, color
-tables, smoothing.  While `wxmplot` does not directly expose all of
-matplotlib's capabilities, it focuses on highly-interactive plotting and image
-display tools that handle many of the most common plotting and image display
-needs for scientific data, and permits access and to the underlying matplotlib
-API for those that need it.
-
-The :mod:`wxmplot.interactive` functions are particularly easy to use, and
-enable script writers to make XY line plots and image displays from their data,
-and to interact with and configure these displays as part of exploratory data
-analysis.  Programmers can use the `wxmplot` widgets to include these high
-quality graphical displays of data in their wxPython applications to enable
-users to explore their data.
+`wxmplot` provides high-level, interactive plotting of scientific data
+for Python, combining `wxPython`_  and `matplotlib`_.
+
+.. image:: images/wxmplot_composite.png
+   :width: 98 %
+
+
+`matplotlib`_ provides excellent general-purpose plotting
+functionality. While it supports many backends, it does not have tight
+integration with any particular GUI toolkit.  And while the
+`matplotlib.pyplot` module provides easy-to-use, high-level functions
+for plotting and displaying data, it has minimal interactivity and
+ability to customize plots after they are mde.
+
+`wxmplot` combines `matplotlib`_ and `wxPython`_ to provide graphical
+elements (wxPython widgets) and user-friendly, interactive functions
+for basic line plots, image display, and some custom plots such as
+histograms and scatter plots.  The displays made with `wxmplot` give
+end-users interactive displays of their data that allow zooming and
+un-zooming, reporting mouse positions, rotating images, and changing
+color themes.  The displays are highly configurable, helping the user
+to change many aspects of the plot such as colors, line types, labels,
+marker type, color tables, smoothing.  While `wxmplot` does not expose
+all of matplotlib's capabilities, it handles many of the most common
+plotting and image display needs for scientific data, and makes these
+highly interactive.  It also permits access and to the underlying
+matplotlib API for those that need it.
+
+The functions in :mod:`wxmplot.interactive` are particularly easy to
+use, and enable script writers to make XY line plots and image
+displays from their data, and to interact with and configure these
+displays as part of exploratory data analysis.  Programmers can use
+the `wxmplot` widgets to include these high quality graphical displays
+of data in their wxPython applications to enable users to explore
+their data.
 
 .. toctree::
    :maxdepth: 2