Updating documentation sources

docs/common.rst

@@ -1,6 +1,6 @@
 Common Functions
 ==================================
 
-.. automodule:: common
+.. automodule:: pynlpl.common
     :members:
     :undoc-members:

docs/conf.py

@@ -13,6 +13,7 @@
 
 import sys, os
 from pynlpl import VERSION
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -38,7 +39,7 @@
 
 # General information about the project.
 project = u'PyNLPl'
-copyright = u'2013, Maarten van Gompel'
+copyright = u'2016, Maarten van Gompel'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -120,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -158,7 +159,7 @@
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PyNLPldoc'
+# htmlhelp_basename = 'pynlpl'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -172,7 +173,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'PyNLPl.tex', u'PyNLPl Documentation',
+  ('index', 'pynlpl.tex', u'PyNLPl Documentation',
    u'Maarten van Gompel', 'manual'),
 ]
 

docs/folia.rst

@@ -927,4 +927,6 @@ API Reference
 .. automodule:: pynlpl.formats.folia
      :members:
      :undoc-members:
+     :special-members:
+
 

docs/formats.rst

@@ -8,6 +8,11 @@ Corpus Gesproken Nederlands
     :members:
     :undoc-members:
 
+FoLiA
+::::::::::::::::::::::::::::::
+
+See folia_ : folia.html
+
 GIZA++
 ::::::::::::::::::::::::::::::
 
@@ -32,10 +37,6 @@ SoNaR
     :undoc-members:
 
 
-FoLiA
-::::::::::::::::::::::::::::::
-
-See folia_ : folia.html
 
 Taggerdata
 ::::::::::::::::::::::::::::::
@@ -52,11 +53,5 @@ TiMBL
     :members:
     :undoc-members:
 
-FoLiA
-::::::::::::::::::::::::::::::
-.. automodule:: formats.folia
-    :members:
-    :undoc-members:
-
 
 

docs/index.rst

@@ -6,7 +6,45 @@
 Welcome to PyNLPl's documentation!
 ==================================
 
-This is the documentation for the Python Natural Language Processing Library (PyNLPl, pronounced as "pineapple"). The library offers a wide variety of modules for various NLP tasks.
+PyNLPl, pronounced as 'pineapple', is a Python library for Natural Language
+Processing. It contains various modules useful for common, and less common, NLP
+tasks. PyNLPl can be used for basic tasks such as the extraction of n-grams and
+frequency lists, and to build simple language model. There are also more
+complex data types and algorithms. Moreover, there are parsers for file formats
+common in NLP (e.g. FoLiA/Giza/Moses/ARPA/Timbl/CQL). There are also clients to
+interface with various NLP specific servers. PyNLPl most notably features a
+very extensive library for working with FoLiA XML (Format for Linguistic
+Annotatation).
+
+The library is a divided into several packages and modules. It works on Python
+2.7, as well as Python 3.
+
+The following modules are available:
+
+- ``pynlpl.datatypes`` - Extra datatypes (priority queues, patterns, tries)
+- ``pynlpl.evaluation`` - Evaluation & experiment classes (parameter search, wrapped
+  progressive sampling, class evaluation (precision/recall/f-score/auc), sampler, confusion matrix, multithreaded experiment pool)
+- ``pynlpl.formats.cgn`` - Module for parsing CGN (Corpus Gesproken Nederlands) part-of-speech tags
+- ``pynlpl.formats.folia`` - Extensive library for reading and manipulating the
+  documents in `FoLiA <http://proycon.github.io/folia>`_ format (Format for Linguistic Annotation).
+- ``pynlpl.formats.fql`` - Extensive library for the FoLiA Query Language (FQL),
+  built on top of ``pynlpl.formats.folia``. FQL is currently documented `here
+  <https://github.com/proycon/foliadocserve>`__. 
+- ``pynlpl.formats.cql`` - Parser for the Corpus Query Language (CQL), as also used by
+  Corpus Workbench and Sketch Engine. Contains a convertor to FQL.
+- ``pynlpl.formats.giza`` - Module for reading GIZA++ word alignment data
+- ``pynlpl.formats.moses`` - Module for reading Moses phrase-translation tables.
+- ``pynlpl.formats.sonar`` - Largely obsolete module for pre-releases of the
+  SoNaR corpus, use ``pynlpl.formats.folia`` instead.
+- ``pynlpl.formats.timbl`` - Module for reading Timbl output (consider using
+  `python-timbl <https://github.com/proycon/python-timbl>`_ instead though)
+- ``pynlpl.lm.lm`` - Module for simple language model and reader for ARPA
+  language model data as well (used by SRILM).
+- ``pynlpl.search`` - Various search algorithms (Breadth-first, depth-first,
+  beam-search, hill climbing, A star, various variants of each)
+- ``pynlpl.statistics`` - Frequency lists, Levenshtein, common statistics and
+  information theory functions
+- ``pynlpl.textprocessors`` - Simple tokeniser, n-gram extraction 
 
 
 Contents:

docs/search.rst

@@ -1,7 +1,7 @@
 Search Algorithms
 ==================================
 
-.. automodule:: search
+.. automodule:: pynlpl.search
     :members:
     :undoc-members:
 

docs/textprocessors.rst

@@ -33,6 +33,6 @@ The input to the Windower should be a list of words and a value for n. In additi
 The Windower is implemented as a Python generator and at each iteration yields a tuple of length n.
 
 
-.. automodule:: textprocessors
+.. automodule:: pynlpl.textprocessors
     :members:
     :undoc-members: