.. ############################################################################
   #    Copyright (C) 2011 - 2011 by Eike Welk                                #
   #    eike.welk@gmx.net                                                     #
   #                                                                          #
   #    License: GPL                                                          #
   #                                                                          #
   #    This program is free software; you can redistribute it and#or modify  #
   #    it under the terms of the GNU General Public License as published by  #
   #    the Free Software Foundation; either version 2 of the License, or     #
   #    (at your option) any later version.                                   #
   #                                                                          #
   #    This program is distributed in the hope that it will be useful,       #
   #    but WITHOUT ANY WARRANTY; without even the implied warranty of        #
   #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         #
   #    GNU General Public License for more details.                          #
   #                                                                          #
   #    You should have received a copy of the GNU General Public License     #
   #    along with this program; if not, write to the                         #
   #    Free Software Foundation, Inc.,                                       #
   #    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             #
   ############################################################################

..  This text contains reStructuredText markup for the documentation generator
    Sphinx. To create the whole website run the following command in directory 
    ``doc/``:
       
        make html 


================================================================================
                        Welcome to JBidwatcher Companion 
================================================================================

**Simple statistical analysis for Ebay auctions, use in conjunction with JBidwatcher.**


The project **JBidwatcher Companion** should become a collection of tools that 
analyze data about Ebay auctions. The programs do not directly interact with
Ebay themselves, but use data that is produced by the Ebay bidding program
**JBidwatcher**.  The tedious task to constantly adapt the program(s) to the 
changing HTML output of Ebay's website, is done by the author of JBidwatcher.
Thank you Morgan_!

For information on JBidwatcher go to: http://www.jbidwatcher.com/

Currently the collection consists of only one program: ``ebstat.py``. 
It creates price vs. time diagrams, with moving median 
price over a configurable period of time. It is a command line program, but 
the diagram is displayed in an interactive window. The diagram can be scaled, 
moved and saved as an image. 

Auctions can be selected for graphing based on flexible criteria. The same 
criteria are also used to group auctions into the lines of the diagram. 

.. figure:: Nikon-SB.png
    :align: left
    :scale: 80%
     
    Time versus price diagram, showing prices for old Nikon flashes in Germany.
    The lines are median prices, computed in a moving window of 50 days. 
    Each small circle represents one auction.

.. more figure options
    :alt: text for blind people and text browsers 
    :align: right
    :figwidth: 90%
    :width: 100% 
    
    These options are mentioned on the web, but they seem not to work
    :figwidth: image
    :figalign: center


Contents
========

.. toctree::
   :maxdepth: 2

   readme
   hacking


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

.. more ``Indices and tables`` entries
    
    * :ref:`modindex`


.. _Morgan: https://profiles.google.com/cyberfox