.. TreeTagger Python Wrapper documentation master file, created by
   sphinx-quickstart on Tue Oct 13 19:53:29 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   Note: moved to some sphinx3 utilities (ex. role any), if necessary
   install a local sphinx with: pip install --user --upgrade sphinx


TreeTagger Python Wrapper's documentation!
******************************************

.. toctree::
   :maxdepth: 2

.. automodule:: treetaggerwrapper

Module exceptions, class and functions
======================================

.. autoexception:: TreeTaggerError

.. autoclass:: TreeTagger

  ..
     Only show doc of methods needed by the user.

  .. automethod:: tag_text
  .. automethod:: tag_file
  .. automethod:: tag_file_to

.. autofunction:: make_tags

Polls of taggers threads
========================

.. autoclass:: TaggerPoll

  .. automethod:: tag_text_async
  .. automethod:: tag_file_async
  .. automethod:: tag_file_to_async
  .. automethod:: stop_poll

.. autoclass:: Job

  .. automethod:: wait_finished


Extra functions
===============

Some functions can be of interest, eventually for another project.

..
    Separated from main content as this is les important and don't have
    to interfer with first reading and module usage comprehension.

.. autofunction:: blank_to_space
.. autofunction:: blank_to_tag
.. autofunction:: enable_debugging_log
.. autofunction:: get_param
.. autofunction:: is_sgml_tag
.. autofunction:: load_configuration
.. autofunction:: locate_treetagger
.. autofunction:: main
.. autofunction:: maketrans_unicode
.. autofunction:: pipe_writer
.. autofunction:: save_configuration
.. autofunction:: split_sgml


.. _polls of taggers process:

Polls of taggers process
========================

.. automodule:: treetaggerpoll

Main process poll classes
-------------------------

  .. autoclass:: TaggerProcessPoll

    .. automethod:: tag_text_async
    .. automethod:: tag_file_async
    .. automethod:: tag_file_to_async
    .. automethod:: stop_poll

  .. autoclass:: ProcJob

    .. automethod:: wait_finished


..
    Removed from doc.

    Indices and tables
    ------------------

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