Update of the documentation

UUDigitalHumanitieslab · Aug 29, 2024 · b0dc72e · b0dc72e
1 parent 8d836c2
commit b0dc72e
Show file tree

Hide file tree

Showing 37 changed files with 180 additions and 399 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/smallclausetable.csv b/docs/smallclausetable.csv
diff --git a/src/sastadev/ASTApostfunctions.py b/src/sastadev/ASTApostfunctions.py
@@ -79,7 +79,7 @@ def neologisme(stree: SynTree) -> List[SynTree]:
     n]" or the special form "@n" applies. It uses the function *mdbasedquery* to
     achieve this.
 
-    .. autofunction:: ASTApostfunctions::mdbasedquery
+    .. autofunction:: sastadev.ASTApostfunctions::mdbasedquery
 
     '''
     results1 = mdbasedquery(stree, errormarking, "['n']")
@@ -93,7 +93,7 @@ def sempar(stree: SynTree) -> List[SynTree]:
     The function *sempar* identifies the nodes for which the CHAT error marking "[*
     s]"  applies. It uses the function *mdbasedquery* to achieve this.
 
-    .. autofunction:: ASTApostfunctions::mdbasedquery
+    .. autofunction:: sastadev.ASTApostfunctions::mdbasedquery
 
 
     '''
@@ -106,7 +106,7 @@ def phonpar(stree: SynTree) -> List[SynTree]:
     The function *phonpar* identifies the nodes for which the CHAT error marking "[*
     p]"  applies. It uses the function *mdbasedquery* to achieve this.
 
-    .. autofunction:: ASTApostfunctions::mdbasedquery
+    .. autofunction:: sastadev.ASTApostfunctions::mdbasedquery
 
     '''
     results = mdbasedquery(stree, errormarking, "['p']")
@@ -280,7 +280,7 @@ def getnounlemmas(allresults, _):
     *allresults* and the query identifier for nouns to obtain the lemmas
     for nouns.
 
-    .. autofunction:: ASTApostfunctions::getposlemmas
+    .. autofunction:: sastadev.ASTApostfunctions::getposlemmas
 
     '''
     result = getposlemmas(allresults, nounreskey)
@@ -293,7 +293,7 @@ def getlexlemmas(allresults, _):
     *allresults* and the query identifier for lexical verbs to obtain the lemmas
     for lexical verbs.
 
-    .. autofunction:: ASTApostfunctions::getposlemmas
+    .. autofunction:: sastadev.ASTApostfunctions::getposlemmas
     '''
     result = getposlemmas(allresults, lexreskey)
     return result

diff --git a/src/sastadev/Sziplus.py b/src/sastadev/Sziplus.py
@@ -3,14 +3,14 @@
 
 * Vr5+: through the function *vr5plus*:
 
-  .. autofunction:: Sziplus::vr5plus
+  .. autofunction:: sastadev.Sziplus::vr5plus
 
   In the meantime a different implementation using macros has replaced this function,
   so it has become obsolete
 
 * 6+: through the function *sziplus6*:
 
-  .. autofunction:: Sziplus::sziplus6
+  .. autofunction:: sastadev.Sziplus::sziplus6
 
 '''
 
@@ -56,7 +56,7 @@ def isindexnode(node: SynTree) -> bool:
 
     The function *noposcatin* is defined as follows:
 
-    .. autofunction:: Sziplus::noposcatin
+    .. autofunction:: sastadev.Sziplus::noposcatin
 
     * **Remark** The function *noposcatin* is better replaced by a function that checks for the absence of the attributes *cat* and *word*.
 
@@ -70,7 +70,7 @@ def isvcinforppart(node: SynTree) -> bool:
     The function *isvcinforppart* determines whether a node is a node for a nonfinite
     verbal complement. That is the case if
 
-    *  its category is one of *inf*, *teinf*, or *ppart*
+    * its category is one of *inf*, *teinf*, or *ppart*
     * its relation has the value *vc*
 
     '''
@@ -85,7 +85,7 @@ def isvcinforppart(node: SynTree) -> bool:
 
 def isrealnode(node: SynTree) -> bool:
     '''
-    The fucntion *isrealnode* determines whether a nide is a real node, which it is if:
+    The function *isrealnode* determines whether a nide is a real node, which it is if:
 
     * it is not a node for an interpunction sign
     * it is not a nonfinite complement
@@ -94,7 +94,7 @@ def isrealnode(node: SynTree) -> bool:
 
     The function *isindexnode* is defined as follows:
 
-    .. autofunction:: Sziplus::isindexnode
+    .. autofunction:: sastadev.Sziplus::isindexnode
     '''
     pt = getattval(node, 'pt')
     rel = getattval(node, 'rel')
@@ -134,11 +134,11 @@ def getnodecount(clause: SynTree) -> int:
 
     The function *isrealnode* is defined as follows:
 
-    .. autofunction:: Sziplus::isrealnode
+    .. autofunction:: sastadev.Sziplus::isrealnode
 
     The function *isvcinforppart* is defined as follows:
 
-    .. autofunction:: Sziplus::isvcinforppart
+    .. autofunction:: sastadev.Sziplus::isvcinforppart
 
     '''
     nodectr = 0
@@ -157,11 +157,11 @@ def sziplus(syntree: SynTree, i: int) -> List[SynTree]:
     The function *sziplus* takes a SynTree *syntree* and an integer *i* and uses the
     function *nodeiplus* by applying it to  *syntree*, *i*, and *clausequery*:
 
-    .. autodata:: Sziplus::clausequery
+    .. autodata:: sastadev.Sziplus::clausequery
 
     The function *nodeiplus* is defined as follows:
 
-    .. autofunction:: Sziplus::nodeiplus
+    .. autofunction:: sastadev.Sziplus::nodeiplus
 
     '''
     results = nodeiplus(syntree, i, clausequery)
@@ -178,11 +178,12 @@ def vr5plus(syntree: SynTree) -> List[SynTree]:
 
     The Xpath *vrquery* is defined as follows:
 
-    .. autodata:: Sziplus::vrquery
+    .. autodata:: sastadev.Sziplus::vrquery
 
     The function *nodeiplus* is defined as follows:
 
-    .. autofunction:: Sziplus::nodeiplus
+    .. autofunction:: sastadev.Sziplus::nodeiplus
+
     '''
     results = nodeiplus(syntree, 5, vrquery)
     return results
@@ -198,7 +199,8 @@ def nodeiplus(syntree: SynTree,
 
     It makes use of the function *getnodecount*, which is defined as follows:
 
-    .. autofunction:: Sziplus::getnodecount
+    .. autofunction:: sastadev.Sziplus::getnodecount
+
     '''
     clauses = syntree.xpath(query)
     results = []
@@ -211,14 +213,12 @@ def nodeiplus(syntree: SynTree,
 
 def sziplus6(syntree: SynTree) -> List[SynTree]:
     '''
-    The function *sziplus6* implements the TARSP language measure *6+*. It makes use of
-    the function *sziplus*, which is applied to the *syntree* in combination with the
-    integer *6*.
+    The function *sziplus6* implements the TARSP language measure *6+*. It makes use of the function *sziplus*, which is applied to the *syntree* in combination with the     integer *6*.
+
+    .. autofunction:: sastadev.Sziplus::sziplus
 
-    .. autofunction:: Sziplus::sziplus
+    * **Remark** The function *sziplus* was written in an early stage, but probably can now be better  rewritten as a composed language measure.
 
-    * **Remark** The function *sziplus* was written in an early stage, but probably can now be better
-    rewritten as a composed language measure.
 
     '''
     results = sziplus(syntree, 6)