diff --git a/docs/abl.bridge.rst b/docs/API/abl.bridge.rst similarity index 71% rename from docs/abl.bridge.rst rename to docs/API/abl.bridge.rst index a1a7c3c..f333f7d 100644 --- a/docs/abl.bridge.rst +++ b/docs/API/abl.bridge.rst @@ -1,10 +1,7 @@ -abl.bridge package +abl.bridge ================== -Submodules ----------- - -abl.bridge.base\_bridge module +abl.bridge.base\_bridge ------------------------------ .. automodule:: abl.bridge.base_bridge @@ -12,7 +9,7 @@ abl.bridge.base\_bridge module :undoc-members: :show-inheritance: -abl.bridge.simple\_bridge module +abl.bridge.simple\_bridge -------------------------------- .. automodule:: abl.bridge.simple_bridge @@ -20,9 +17,6 @@ abl.bridge.simple\_bridge module :undoc-members: :show-inheritance: -Module contents ---------------- - .. automodule:: abl.bridge :members: :undoc-members: diff --git a/docs/abl.dataset.rst b/docs/API/abl.dataset.rst similarity index 73% rename from docs/abl.dataset.rst rename to docs/API/abl.dataset.rst index 330888a..a09240b 100644 --- a/docs/abl.dataset.rst +++ b/docs/API/abl.dataset.rst @@ -1,10 +1,8 @@ -abl.dataset package -=================== - -Submodules +abl.dataset +================== ---------- -abl.dataset.bridge\_dataset module +abl.dataset.bridge\_dataset ---------------------------------- .. automodule:: abl.dataset.bridge_dataset @@ -12,7 +10,7 @@ abl.dataset.bridge\_dataset module :undoc-members: :show-inheritance: -abl.dataset.classification\_dataset module +abl.dataset.classification\_dataset ------------------------------------------ .. automodule:: abl.dataset.classification_dataset @@ -20,7 +18,7 @@ abl.dataset.classification\_dataset module :undoc-members: :show-inheritance: -abl.dataset.prediction\_dataset module +abl.dataset.prediction\_dataset -------------------------------------- .. automodule:: abl.dataset.prediction_dataset @@ -28,7 +26,7 @@ abl.dataset.prediction\_dataset module :undoc-members: :show-inheritance: -abl.dataset.regression\_dataset module +abl.dataset.regression\_dataset -------------------------------------- .. automodule:: abl.dataset.regression_dataset @@ -36,8 +34,6 @@ abl.dataset.regression\_dataset module :undoc-members: :show-inheritance: -Module contents ---------------- .. automodule:: abl.dataset :members: diff --git a/docs/abl.evaluation.rst b/docs/API/abl.evaluation.rst similarity index 70% rename from docs/abl.evaluation.rst rename to docs/API/abl.evaluation.rst index 482f0ba..c34d138 100644 --- a/docs/abl.evaluation.rst +++ b/docs/API/abl.evaluation.rst @@ -1,10 +1,7 @@ -abl.evaluation package -====================== +abl.evaluation +================== -Submodules ----------- - -abl.evaluation.base\_metric module +abl.evaluation.base\_metric ---------------------------------- .. automodule:: abl.evaluation.base_metric @@ -12,7 +9,7 @@ abl.evaluation.base\_metric module :undoc-members: :show-inheritance: -abl.evaluation.semantics\_metric module +abl.evaluation.semantics\_metric --------------------------------------- .. automodule:: abl.evaluation.semantics_metric @@ -20,7 +17,7 @@ abl.evaluation.semantics\_metric module :undoc-members: :show-inheritance: -abl.evaluation.symbol\_metric module +abl.evaluation.symbol\_metric ------------------------------------ .. automodule:: abl.evaluation.symbol_metric @@ -28,8 +25,6 @@ abl.evaluation.symbol\_metric module :undoc-members: :show-inheritance: -Module contents ---------------- .. automodule:: abl.evaluation :members: diff --git a/docs/abl.learning.rst b/docs/API/abl.learning.rst similarity index 67% rename from docs/abl.learning.rst rename to docs/API/abl.learning.rst index ea46f73..dbe1e02 100644 --- a/docs/abl.learning.rst +++ b/docs/API/abl.learning.rst @@ -1,10 +1,7 @@ -abl.learning package -==================== +abl.learning +================== -Submodules ----------- - -abl.learning.abl\_model module +abl.learning.abl\_model ------------------------------ .. automodule:: abl.learning.abl_model @@ -12,7 +9,7 @@ abl.learning.abl\_model module :undoc-members: :show-inheritance: -abl.learning.basic\_nn module +abl.learning.basic\_nn ----------------------------- .. automodule:: abl.learning.basic_nn @@ -20,8 +17,6 @@ abl.learning.basic\_nn module :undoc-members: :show-inheritance: -Module contents ---------------- .. automodule:: abl.learning :members: diff --git a/docs/abl.reasoning.rst b/docs/API/abl.reasoning.rst similarity index 67% rename from docs/abl.reasoning.rst rename to docs/API/abl.reasoning.rst index db82a85..9eeb933 100644 --- a/docs/abl.reasoning.rst +++ b/docs/API/abl.reasoning.rst @@ -1,10 +1,7 @@ -abl.reasoning package -===================== +abl.reasoning +================== -Submodules ----------- - -abl.reasoning.kb module +abl.reasoning.kb ----------------------- .. automodule:: abl.reasoning.kb @@ -12,7 +9,7 @@ abl.reasoning.kb module :undoc-members: :show-inheritance: -abl.reasoning.reasoner module +abl.reasoning.reasoner ----------------------------- .. automodule:: abl.reasoning.reasoner @@ -20,8 +17,6 @@ abl.reasoning.reasoner module :undoc-members: :show-inheritance: -Module contents ---------------- .. automodule:: abl.reasoning :members: diff --git a/docs/abl.structures.rst b/docs/API/abl.structures.rst similarity index 67% rename from docs/abl.structures.rst rename to docs/API/abl.structures.rst index 88229af..7797f0f 100644 --- a/docs/abl.structures.rst +++ b/docs/API/abl.structures.rst @@ -1,10 +1,7 @@ -abl.structures package -====================== +abl.structures +================== -Submodules ----------- - -abl.structures.base\_data\_element module +abl.structures.base\_data\_element ----------------------------------------- .. automodule:: abl.structures.base_data_element @@ -12,7 +9,7 @@ abl.structures.base\_data\_element module :undoc-members: :show-inheritance: -abl.structures.list\_data module +abl.structures.list\_data -------------------------------- .. automodule:: abl.structures.list_data @@ -20,9 +17,6 @@ abl.structures.list\_data module :undoc-members: :show-inheritance: -Module contents ---------------- - .. automodule:: abl.structures :members: :undoc-members: diff --git a/docs/abl.utils.rst b/docs/API/abl.utils.rst similarity index 73% rename from docs/abl.utils.rst rename to docs/API/abl.utils.rst index e340f3a..e9532f3 100644 --- a/docs/abl.utils.rst +++ b/docs/API/abl.utils.rst @@ -1,10 +1,7 @@ -abl.utils package -================= +abl.utils +================== -Submodules ----------- - -abl.utils.cache module +abl.utils.cache ---------------------- .. automodule:: abl.utils.cache @@ -12,7 +9,7 @@ abl.utils.cache module :undoc-members: :show-inheritance: -abl.utils.logger module +abl.utils.logger ----------------------- .. automodule:: abl.utils.logger @@ -20,7 +17,7 @@ abl.utils.logger module :undoc-members: :show-inheritance: -abl.utils.manager module +abl.utils.manager ------------------------ .. automodule:: abl.utils.manager @@ -28,7 +25,7 @@ abl.utils.manager module :undoc-members: :show-inheritance: -abl.utils.utils module +abl.utils.utils ---------------------- .. automodule:: abl.utils.utils @@ -36,9 +33,6 @@ abl.utils.utils module :undoc-members: :show-inheritance: -Module contents ---------------- - .. automodule:: abl.utils :members: :undoc-members: diff --git a/docs/Brief-Introduction/Introduction.rst b/docs/Brief-Introduction/Introduction.rst new file mode 100644 index 0000000..09cea8c --- /dev/null +++ b/docs/Brief-Introduction/Introduction.rst @@ -0,0 +1,12 @@ +A Brief Introduction to ABL-Package +================== + +.. contents:: Table of Contents + +ABL-Package Components +---------------------------------------- + + + +Use ABL-Package step by step +------------------------------ \ No newline at end of file diff --git a/docs/Examples/HED.rst b/docs/Examples/HED.rst new file mode 100644 index 0000000..5af4d81 --- /dev/null +++ b/docs/Examples/HED.rst @@ -0,0 +1,5 @@ +Handwritten Equation Deciphering (HED) +================== + +.. contents:: Table of Contents + diff --git a/docs/Examples/HWF.rst b/docs/Examples/HWF.rst new file mode 100644 index 0000000..98f4c29 --- /dev/null +++ b/docs/Examples/HWF.rst @@ -0,0 +1,5 @@ +Handwritten Formula (HWF) +================== + +.. contents:: Table of Contents + diff --git a/docs/Examples/MNISTAdd.rst b/docs/Examples/MNISTAdd.rst new file mode 100644 index 0000000..2390fbc --- /dev/null +++ b/docs/Examples/MNISTAdd.rst @@ -0,0 +1,5 @@ +MNIST Add +================== + +.. contents:: Table of Contents + diff --git a/docs/Makefile b/docs/Makefile index d4bb2cb..caeb32e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,12 +1,12 @@ # Minimal makefile for Sphinx documentation # -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = ABL-Package SOURCEDIR = . -BUILDDIR = _build +BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/Overview/Abductive Learning.rst b/docs/Overview/Abductive Learning.rst new file mode 100644 index 0000000..e11941a --- /dev/null +++ b/docs/Overview/Abductive Learning.rst @@ -0,0 +1,5 @@ +Abductive Learning +================== + +.. contents:: Table of Contents + diff --git a/docs/Overview/Installation.rst b/docs/Overview/Installation.rst new file mode 100644 index 0000000..2112f28 --- /dev/null +++ b/docs/Overview/Installation.rst @@ -0,0 +1,5 @@ +Installation +================== + +.. contents:: Table of Contents + diff --git a/docs/Overview/Quick Start.rst b/docs/Overview/Quick Start.rst new file mode 100644 index 0000000..7ef22bb --- /dev/null +++ b/docs/Overview/Quick Start.rst @@ -0,0 +1,5 @@ +Quick Start +================== + +.. contents:: Table of Contents + diff --git a/docs/README.rst b/docs/README.rst index 18600c4..a7adb92 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,4 +1,4 @@ -ABL +ABL-Package ^^^^^^ ABL(Abductive Learning) is ... diff --git a/docs/References.rst b/docs/References.rst new file mode 100644 index 0000000..64f726b --- /dev/null +++ b/docs/References.rst @@ -0,0 +1,5 @@ +References +================== + +.. contents:: Table of Contents + diff --git a/docs/abl.rst b/docs/abl.rst deleted file mode 100644 index 63922ac..0000000 --- a/docs/abl.rst +++ /dev/null @@ -1,24 +0,0 @@ -abl package -=========== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - abl.bridge - abl.dataset - abl.evaluation - abl.learning - abl.reasoning - abl.structures - abl.utils - -Module contents ---------------- - -.. automodule:: abl - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 9b5f864..aa3bff1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,10 +1,3 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information import sys import os import re @@ -36,22 +29,6 @@ extensions = [ 'sphinx_markdown_tables', ] -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -language = 'en' - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'sphinx_rtd_theme' -html_theme_options = { - 'display_version': True -} - -# -- Options for todo extension ---------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration - templates_path = ['_templates'] source_suffix = ['.rst', '.md'] exclude_patterns = [] @@ -89,6 +66,7 @@ texinfo_documents = [ ('index', slug, project, author, slug, project, 'Miscellaneous'), ] + # Extensions to theme docs def setup(app): from sphinx.domains.python import PyField diff --git a/docs/index.rst b/docs/index.rst index 6ecfba3..2aaaa19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,44 @@ -.. ABL-Package documentation master file, created by - sphinx-quickstart on Mon Nov 27 13:13:16 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. include:: README.rst -Welcome to ABL-Package's documentation! -======================================= +.. toctree:: + :maxdepth: 2 + :caption: Overview + + Overview/Abductive Learning + Overview/Quick Start + Overview/Installation + +.. toctree:: + :maxdepth: 2 + :caption: A Brief Introduction to ABL-Package + + Brief-Introduction/Introduction .. toctree:: - :maxdepth: 4 - :caption: Contents: + :maxdepth: 2 + :caption: Examples + + Examples/MNISTAdd + Examples/HWF + Examples/HED - abl - setup +.. toctree:: + :maxdepth: 1 + :caption: API + + API/abl.bridge + API/abl.dataset + API/abl.evaluation + API/abl.learning + API/abl.reasoning + API/abl.structures + API/abl.utils + +.. toctree:: + :maxdepth: 2 + :caption: References + + References -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat index 32bb245..ce105e9 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -5,31 +5,34 @@ pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build + set SPHINXBUILD=python -msphinx ) +set SPHINXOPTS= +set SPHINXBUILD=sphinx-build set SOURCEDIR=. -set BUILDDIR=_build +set BUILDDIR=build +set SPHINXPROJ=ReadtheDocsSphinxTheme + +if "%1" == "" goto help %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ + echo.http://sphinx-doc.org/ exit /b 1 ) -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% goto end :help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% :end -popd +popd \ No newline at end of file diff --git a/docs/setup.rst b/docs/setup.rst deleted file mode 100644 index 552eb49..0000000 --- a/docs/setup.rst +++ /dev/null @@ -1,7 +0,0 @@ -setup module -============ - -.. automodule:: setup - :members: - :undoc-members: - :show-inheritance: