Skip to content
Extraits de code Groupes Projets
Valider a8d8ed64 rédigé par Patrick Watrin's avatar Patrick Watrin
Parcourir les fichiers

first documentation system

parent 3971d2ec
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
The `_unitex` C++ extension
===========================
Summary
-------
.. currentmodule:: _unitex
.. autosummary::
_unitex.unitex_tool
_unitex.unitex_load_persistent_dictionary
_unitex.unitex_load_persistent_fst2
_unitex.unitex_load_persistent_alphabet
_unitex.unitex_free_persistent_dictionary
_unitex.unitex_free_persistent_fst2
_unitex.unitex_free_persistent_alphabet
_unitex.unitex_is_persistent_dictionary
_unitex.unitex_is_persistent_fst2
_unitex.unitex_is_persistent_alphabet
_unitex.unitex_enable_stdout
_unitex.unitex_disable_stdout
_unitex.unitex_enable_stderr
_unitex.unitex_disable_stderr
_unitex.unitex_cp
_unitex.unitex_rm
_unitex.unitex_mv
_unitex.unitex_mkdir
_unitex.unitex_rmdir
_unitex.unitex_ls
_unitex.unitex_read_file
_unitex.unitex_write_file
_unitex.unitex_append_to_file
Contents
--------
.. automodule:: _unitex
:members:
......@@ -114,7 +114,13 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
#html_theme = 'alabaster'
html_theme = 'nature'
#html_theme = "classic"
#html_theme_options = {
# "rightsidebar": "true",
# "relbarbgcolor": "black"
#}
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......
......@@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 1
_unitex
unitex
Indices and tables
......
unitex
======
.. toctree::
:maxdepth: 4
unitex
The `unitex.config` package
===========================
Summary
-------
.. currentmodule:: unitex.config
.. autosummary::
unitex.config.Options
unitex.config.CheckDicOptions
unitex.config.CompressOptions
unitex.config.ConcordOptions
unitex.config.DicoOptions
unitex.config.ExtractOptions
unitex.config.Fst2TxtOptions
unitex.config.Grf2Fst2Options
unitex.config.LocateOptions
unitex.config.NormalizeOptions
unitex.config.SortTxtOptions
unitex.config.TokenizeOptions
unitex.config.Txt2TFstOptions
unitex.config.ResourcesOptions
unitex.config.UnitexConfig
Contents
--------
.. automodule:: unitex.config
:members:
The `unitex.io` package
=======================
Summary
-------
.. currentmodule:: unitex.io
.. autosummary::
unitex.io.UnitexFile
unitex.io.cp
unitex.io.rm
unitex.io.mv
unitex.io.mkdir
unitex.io.rmdir
unitex.io.ls
unitex.io.exists
Contents
--------
.. automodule:: unitex.io
:members:
The `unitex.processor` package
==============================
Summary
-------
.. currentmodule:: unitex.processor
.. autosummary::
unitex.processor.UnitexProcessor
Contents
--------
.. automodule:: unitex.processor
:members:
The `unitex.resources` package
==============================
Summary
-------
.. currentmodule:: unitex.resources
.. autosummary::
unitex.resources.load_persistent_dictionary
unitex.resources.is_persistent_dictionary
unitex.resources.free_persistent_dictionary
unitex.resources.load_persistent_fst2
unitex.resources.is_persistent_fst2
unitex.resources.free_persistent_fst2
unitex.resources.load_persistent_alphabet
unitex.resources.is_persistent_alphabet
unitex.resources.free_persistent_alphabet
Contents
--------
.. automodule:: unitex.resources
:members:
The `unitex.tools` package
==========================
Summary
-------
.. currentmodule:: unitex.tools
.. autosummary::
unitex.tools.check_dic
unitex.tools.compress
unitex.tools.concord
unitex.tools.dico
unitex.tools.extract
unitex.tools.fst2txt
unitex.tools.grf2fst2
unitex.tools.locate
unitex.tools.normalize
unitex.tools.sort_txt
unitex.tools.tokenize
unitex.tools.txt2tfst
Contents
--------
.. automodule:: unitex.tools
:members:
unitex module
=============
The `unitex` package
====================
Module contents
---------------
Summary
-------
.. currentmodule:: unitex
.. autosummary::
unitex.UnitexConstants
unitex.disable_stderr
unitex.disable_stdout
unitex.enable_stderr
unitex.enable_stdout
unitex.init_log_system
Submodules
----------
.. toctree::
:maxdepth: 1
unitex.tools <unitex-tools>
unitex.resources <unitex-resources>
unitex.io <unitex-io>
unitex.processor <unitex-processor>
unitex.config <unitex-config>
Contents
--------
.. automodule:: unitex
:members:
:undoc-members:
......@@ -118,8 +118,8 @@ setup(name = "unitex",
library_dirs=['/usr/local/lib'],
sources = ["extensions/_unitex.cpp"])],
cmdclass = {
"build": CustomBuild,
"clean": CustomClean
}
# cmdclass = {
# "build": CustomBuild,
# "clean": CustomClean
# }
)
......@@ -18,6 +18,9 @@ class UnitexException(Exception):
class UnitexConstants(object):
"""
This class lists all the constants used by the Unitex processor.
"""
DEFAULT_ENCODING="utf-8"
......
......@@ -119,8 +119,8 @@ def compress(dictionary, **kwargs):
dictionary (default: False).
- **version [str]** -- Possible values are:
- UnitexConstants.DICTIONARY_VERSION_1: produces an old style .bin
UnitexConstants.DICTIONARY_VERfile;
- UnitexConstants.DICTIONARY_VERSION_2: produces a new style .bin
file, with no file size limitation to 16 Mb and a smaller size
(default).
......@@ -796,21 +796,25 @@ def locate(grammar, text, alphabet, **kwargs):
compatibility with previous versions of Unitex.
- *Search limit options:*
- **number_of_matches [int]** -- stops after the first N matches
(default: all matches).
- *Maximum iterations per token options:*
- **stop_token_count [list(int_1, int_2)]** -- emits a warning
after 'int_1' iterations on a token and stops after 'int_2'
iterations.
- *Matching mode options:*
- **match_mode [str]** -- Possible values are:
- UnitexConstants.MATCH_MODE_SHORTEST
- UnitexConstants.MATCH_MODE_LONGEST (default)
- UnitexConstants.MATCH_MODE_ALL
- Output options:
- **output_mode [str]** -- Possible values are:
- UnitexConstants.OUTPUT_MODE_IGNORE (default)
- UnitexConstants.OUTPUT_MODE_MERGE
......@@ -826,6 +830,7 @@ def locate(grammar, text, alphabet, **kwargs):
named str_1 with content str_2. Note that str_2 must be ASCII.
- *Ambiguous output options:*
- **ambiguous_outputs [bool]** -- allows the production of several
matches with same input but different outputs. If False, in case
of ambiguous outputs, one will be arbitrarily chosen and kept,
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter