.. pygtkscintilla documentation master file, created by
   sphinx-quickstart on Sat Aug 22 21:48:39 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pygtkscintilla's documentation!
==========================================

Introduction
------------

Scintilla is a powerful source editing widget written in C/C++ for GTK+.
It supports features such as code folding, autocompletion, syntax highlighting and calltips.

pygtkscintilla is a Scintilla wrapper for pygtk and it can be used to develop
powerful editors. 
The original widget is not much GTK-like, I'm trying to make 
it more accessible for pygtk developers, however I can't change the internal
structure of Scintilla, so a lot of things may appear "strange".

I suggest you to start with the overview to have an introduction of the 
mechanism of the scintilla editor.

Then you can move on the near complete documentation, however for those methods not
documented you can refer to [http://www.scintilla.org/ScintillaDoc.html], the
original Scintilla documentation.

Good Coding!

Contents:

.. toctree::
   :maxdepth: 2

   overview

Build Instructions
------------------

There are some dependencies to satisfy before building:
  
   * python-dev
   * python-gobject-dev
   * python-gtk-2.0-dev
 
 
From source package
~~~~~~~~~~~~~~~~~~~

Download the source distribution:

 $ wget http://downloads.sourceforge.net/project/pygtksci/pygtkscintilla-0.2.tar.gz

To build the package you can follow the standard way::

 $ ./configure
 $ make
 # make install or $ sudo make install

That's it! This installs the library under the /usr/local prefix, if you want
to modify it, for example to install in /usr::

 $ ./configure --prefix=/usr
 $ make
 # make install or $ sudo make install

From svn version
~~~~~~~~~~~~~~~~

Download svn version::

 $ svn co https://pygtksci.svn.sourceforge.net/svnroot/pygtksci/trunk pygtksci
 $ cd pygtksci

Execute these commands::

 $ aclocal
 $ libtoolize # Use 'libtoolize -c' to copy files instead of creating symlinks
 $ automake --add-missing # Add '--copy' to copy files instead of creating symlinks
 $ autoconf
 $ ./configure
 $ make

To try it without installing::

 $ cd src/
 $ cp .libs/gtkscintilla.so gtkscintilla
 $ python test.py


Reference Guide
---------------

.. toctree::

   reference/index

Links
-----

* Sourceforge project page : [https://sourceforge.net/projects/pygtksci/]
* wiki : [https://sourceforge.net/apps/trac/pygtksci/wiki]

Contact us
~~~~~~~~~~

There's the mailing list, chech this link:
https://lists.sourceforge.net/lists/listinfo/pygtksci-users

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

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