[DOC] reformat API

.gitignore

@@ -9,4 +9,5 @@ raw/
 abl.egg-info/
 examples/**/*.jpg
 .idea/
-build/
+build/
+docs/API/generated/

docs/API/abl.bridge.rst

@@ -1,23 +1,18 @@
+.. role:: hidden
+    :class: hidden-section
+
 abl.bridge
 ==================
 
-abl.bridge.base\_bridge
-------------------------------
-
-.. automodule:: abl.bridge.base_bridge
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. currentmodule:: abl.bridge
 
-abl.bridge.simple\_bridge
---------------------------------
+Bridge
+-------
 
-.. automodule:: abl.bridge.simple_bridge
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.bridge
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   BaseBridge
+   SimpleBridge

docs/API/abl.dataset.rst

@@ -1,40 +1,17 @@
 abl.dataset
 ==================
 
-abl.dataset.bridge\_dataset
-----------------------------------
+.. currentmodule:: abl.dataset
 
-.. automodule:: abl.dataset.bridge_dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Dataset
+-------
 
-abl.dataset.classification\_dataset
-------------------------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.dataset.classification_dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-abl.dataset.prediction\_dataset
---------------------------------------
-
-.. automodule:: abl.dataset.prediction_dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-abl.dataset.regression\_dataset
---------------------------------------
-
-.. automodule:: abl.dataset.regression_dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-.. automodule:: abl.dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   BridgeDataset
+   ClassificationDataset
+   PredictionDataset
+   RegressionDataset

docs/API/abl.evaluation.rst

@@ -1,32 +1,16 @@
 abl.evaluation
 ==================
 
-abl.evaluation.base\_metric
-----------------------------------
+.. currentmodule:: abl.evaluation
 
-.. automodule:: abl.evaluation.base_metric
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Metrics
+-------
 
-abl.evaluation.semantics\_metric
----------------------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.evaluation.semantics_metric
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-abl.evaluation.symbol\_metric
-------------------------------------
-
-.. automodule:: abl.evaluation.symbol_metric
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-.. automodule:: abl.evaluation
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   BaseMetric
+   SymbolMetric
+   SemanticsMetric

docs/API/abl.learning.rst

@@ -1,24 +1,15 @@
 abl.learning
 ==================
 
-abl.learning.abl\_model
-------------------------------
+.. currentmodule:: abl.learning
 
-.. automodule:: abl.learning.abl_model
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Learning
+--------
 
-abl.learning.basic\_nn
------------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.learning.basic_nn
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-.. automodule:: abl.learning
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   ABLModel
+   BasicNN

docs/API/abl.reasoning.rst

@@ -1,24 +1,27 @@
 abl.reasoning
 ==================
 
-abl.reasoning.kb
------------------------
+.. currentmodule:: abl.reasoning
 
-.. automodule:: abl.reasoning.kb
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Reasoning
+---------
 
-abl.reasoning.reasoner
------------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.reasoning.reasoner
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   Reasoner
 
+Knowledge Base
+--------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
+
+   KBBase
+   GroundKB
+   PrologKB
 
-.. automodule:: abl.reasoning
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/API/abl.structures.rst

@@ -1,23 +1,15 @@
 abl.structures
 ==================
 
-abl.structures.base\_data\_element
------------------------------------------
+.. currentmodule:: abl.structures
 
-.. automodule:: abl.structures.base_data_element
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Data Structures
+----------------
 
-abl.structures.list\_data
---------------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.structures.list_data
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: abl.structures
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   BaseDataElement
+   ListData

docs/API/abl.utils.rst

@@ -1,39 +1,40 @@
 abl.utils
-==================
+===========
 
-abl.utils.cache
-----------------------
+.. currentmodule:: abl.utils
 
-.. automodule:: abl.utils.cache
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Logger
+-------
 
-abl.utils.logger
------------------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-.. automodule:: abl.utils.logger
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   ABLLogger
 
-abl.utils.manager
-------------------------
+Cache
+------
 
-.. automodule:: abl.utils.manager
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
 
-abl.utils.utils
-----------------------
+   Cache
+   abl_cache
 
-.. automodule:: abl.utils.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Utils
+------
 
-.. automodule:: abl.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
+
+   calculate_revision_num
+   confidence_dist
+   flatten
+   hamming_dist
+   reform_list
+   to_hashable

docs/_static/custom.css

@@ -1,3 +1,28 @@
 div.code-out > div.highlight > pre {
     background-color: #d3effd !important; 
-}
+}
+
+.autosummary.longtable.docutils.align-default {
+    width: 100%;
+}
+
+.autosummary.longtable.docutils.align-default td {
+    word-wrap: break-word;
+    white-space: normal;
+}
+
+.row-odd td:first-child .pre {
+    font-size: 110%;
+    color: #4682B4;
+}
+
+.row-even td:first-child .pre {
+    font-size: 110%;
+    color: #4682B4;
+}
+
+.autosummary.longtable.docutils.align-default td:first-child {
+    width: 30%;
+    text-align: left;
+}
+

docs/_templates/classtemplate.rst

@@ -0,0 +1,10 @@
+.. role:: hidden
+    :class: hidden-section
+
+.. currentmodule:: {{ module }}
+
+{{ name | underline }}
+
+.. autoclass:: {{ name }}
+    :members:
+    :show-inheritance:

docs/conf.py

@@ -20,6 +20,7 @@ author = "Author"
 extensions = [
     "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
+    'sphinx.ext.autosummary',
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx_rtd_theme",

docs/index.rst

@@ -31,11 +31,11 @@
    :maxdepth: 1
    :caption: API
 
-   API/abl.bridge
    API/abl.dataset
-   API/abl.evaluation
    API/abl.learning
    API/abl.reasoning
+   API/abl.evaluation
+   API/abl.bridge
    API/abl.structures
    API/abl.utils