doc: document all modules

Author: jdreo

docs/overview.rst

@@ -2,6 +2,9 @@
 OntoWeaver is a tool that automatize the creation of knowledge graphs
 from iterable data.
 
+The project is maintained on Github at
+`oncodash/ontoweaver <https://github.com/oncodash/ontoweaver>`_
+
 .. figure:: OntoWeaver__very-simple-summary.svg
 
     OntoWeaver allows you to create Semantic Knowledge Graphs from

src/ontoweaver/base.py

@@ -1,3 +1,5 @@
+""" Interfaces for OntoWeaver.
+"""
 import logging
 import math
 

src/ontoweaver/congregate.py

@@ -1,3 +1,5 @@
+""" Information fusion features for finding duplicates.
+"""
 import logging
 from abc import ABCMeta as ABSTRACT, ABCMeta, abstractmethod
 

src/ontoweaver/errormanager.py

@@ -1,3 +1,5 @@
+""" Base class for errors management.
+"""
 import logging
 
 logger = logging.getLogger("ontoweaver")

src/ontoweaver/exceptions.py

@@ -1,30 +1,39 @@
-
-# OntoWeaverError
-# ├─ AutoSchemaError
-# ├─ ConfigError
-# ├─ FeatureError
-# ├─ ParsingError
-# │  ├─ ParsingDeclarationsError
-# │  │  ├─ CardinalityError
-# │  │  └─ MissingDataError
-# │  ├─ # ParsingPropertiesError
-# │  │  └─ # MissingFieldError
-# └─ RunError
-#    ├─ DeclarationError
-#    ├─ FileError
-#    │  ├─ FileAccessError
-#    │  └─ FileOverwriteError
-#    ├─ InputDataError
-#    ├─ SubprocessError
-#    └─ TransformerError
-#       ├─ DataValidationError
-#       ├─ InterfaceInheritanceError
-#       ├─ TransformerConfigError
-#       ├─ TransformerDataError
-#       ├─ TransformerInputError
-#       └─ TransformerInterfaceError
+"""
+The exceptions hierarchy of what OntoWeaver may raise.
+
+Classes in this file all have a static ``code`` variable,
+which is used by the ``ontoweave`` command as an error return code.
+
+The exceptions taxonomy is::
+    
+    OntoWeaverError
+    ├─ AutoSchemaError
+    ├─ ConfigError
+    ├─ FeatureError
+    ├─ ParsingError
+    │  ├─ ParsingDeclarationsError
+    │  │  ├─ CardinalityError
+    │  │  └─ MissingDataError
+    │  ├─ # ParsingPropertiesError
+    │  │  └─ # MissingFieldError
+    └─ RunError
+       ├─ DeclarationError
+       ├─ FileError
+       │  ├─ FileAccessError
+       │  └─ FileOverwriteError
+       ├─ InputDataError
+       ├─ SubprocessError
+       └─ TransformerError
+          ├─ DataValidationError
+          ├─ InterfaceInheritanceError
+          ├─ TransformerConfigError
+          ├─ TransformerDataError
+          ├─ TransformerInputError
+          └─ TransformerInterfaceError
+"""
 
 class OntoWeaverError(Exception):
+    """The base of all errors related to OntoWeaver."""
     code = 255
 
 class AutoSchemaError(OntoWeaverError):

src/ontoweaver/fuse.py

@@ -1,3 +1,5 @@
+""" Module for fusing two elements.
+"""
 import logging
 from abc import ABCMeta, abstractmethod
 

src/ontoweaver/fusion.py

@@ -1,3 +1,5 @@
+""" High-level fusion module.
+"""
 import logging
 from abc import abstractmethod, ABCMeta
 from typing import Optional

src/ontoweaver/iterative.py

@@ -1,3 +1,5 @@
+""" Adapters managing iterable data.
+"""
 import logging
 import threading
 

src/ontoweaver/json.py

@@ -1,3 +1,5 @@
+""" Adapters for querying JSON data.
+"""
 import json
 import logging
 import jmespath

src/ontoweaver/loader.py

@@ -1,3 +1,5 @@
+""" Classes related to loading input data.
+"""
 import glob
 import rdflib
 import pathlib