File: documentation.rst

package info (click to toggle)
pygtkspellcheck 4.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 480 kB
  • ctags: 226
  • sloc: python: 1,079; makefile: 132
file content (62 lines) | stat: -rw-r--r-- 1,629 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{% names['full'] %}
{% '=' * len(names['full']) %}
{% linkify(description['long'], 'rst') %}

Features
--------
{% '- ' + '\n- '.join(features) %}

API Reference
-------------
.. autoclass:: gtkspellcheck.spellcheck.SpellChecker
   :members:
   
.. autoclass:: gtkspellcheck.spellcheck.NoDictionariesFound

.. autoclass:: gtkspellcheck.spellcheck.NoGtkBindingFound
	
.. autofunction:: pylocales.code_to_name

.. autofunction:: gtkspellcheck.oxt_extract.extract

.. autofunction:: gtkspellcheck.oxt_extract.batch_extract

.. autoclass:: gtkspellcheck.oxt_extract.BadXml

.. autoclass:: gtkspellcheck.oxt_extract.BadExtensionFile

.. autoclass:: gtkspellcheck.oxt_extract.ExtractPathIsNoDirectory

Development
-----------
Development happens at `GitHub`_.

.. _GitHub: {% development %}

	``git clone git://github.com/koehlma/pygtkspellcheck.git``

Download last sources in a `ZIP`_ or `Tarball`_ file.

.. _ZIP: https://github.com/koehlma/pygtkspellcheck/zipball/master
.. _Tarball: https://github.com/koehlma/pygtkspellcheck/tarball/master

Website
-------
Checkout the `official project website`_ for additional information.

.. _official project website: {% homepage %}

Examples
--------
- `PyGObject Simple Example`_
- `PyGtk Simple Example`_

.. _PyGObject Simple Example: https://github.com/koehlma/pygtkspellcheck/blob/master/examples/simple_pygobject.py
.. _PyGtk Simple Example: https://github.com/koehlma/pygtkspellcheck/blob/master/examples/simple_pygtk.py


License
-------
{% names['short'] %} is released under `GPLv3`_ or at your opinion any later version.

.. _GPLv3: https://www.gnu.org/licenses/gpl-3.0.html