fix document

AUTHORS.rst

@@ -2,13 +2,14 @@
 
 About the Author
 ------------------------------------------------------------------------------
-
 ::
 
    (\ (\
-   ( -.-)o    I am a lovely Rabbit!
+   ( -.-)o
    o_(")(")
 
-**Sanhe Hu** is a very active **Python Developer** Since 2010. Research area includes **Machine Learning, Big Data Infrastructure, Block Chain, Business Intelligent, AWS, Distributive System**. Love photography, outdoor, arts, game, and also the best `Python <https://www.python.org/>`_.
+**Sanhe Hu** is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 20+ open-source projects, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in Amazon Web Services, Cloud Engineering, DevOps, Big Data, and Machine Learning, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.
+
+Talk is cheap, show me the code:
 
 - My Github: https://github.com/MacHu-GWU

README.rst

@@ -18,12 +18,14 @@
 .. image:: https://img.shields.io/pypi/pyversions/afwf.svg
     :target: https://pypi.python.org/pypi/afwf
 
+.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
+    :target: https://github.com/MacHu-GWU/afwf-project/blob/main/release-history.rst
+
 .. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
     :target: https://github.com/MacHu-GWU/afwf-project
 
 ------
 
-
 .. image:: https://img.shields.io/badge/Link-Document-blue.svg
     :target: https://afwf.readthedocs.io/index.html
 

afwf/icon.py

@@ -8,12 +8,10 @@
 
 dir_icons = os.path.join(os.path.dirname(os.path.abspath(__file__)), "icons")
 
-
 class IconFileEnum:
     """
     List of built-in icon files.
     """
-
     dictionary = os.path.join(dir_icons, "dictionary-96.png")
     search = os.path.join(dir_icons, "search-96.png")
     refresh = os.path.join(dir_icons, "refresh-96.png")

docs/source/afwf/__init__.rst

@@ -10,12 +10,12 @@ sub packages and modules
 .. toctree::
     :maxdepth: 1
 
+    example_wf <example_wf/__init__>
+    opt <opt/__init__>
     _icon <_icon>
-    enumeration <enumeration>
     handler <handler>
     icon <icon>
     item <item>
-    path <path>
     query <query>
     script_filter <script_filter>
     script_filter_object <script_filter_object>

docs/source/afwf/example_wf/__init__.rst

@@ -0,0 +1,15 @@
+example_wf
+==========
+
+.. automodule:: afwf.example_wf
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    handlers <handlers/__init__>
+    cache <cache>
+

docs/source/afwf/example_wf/cache.rst

@@ -0,0 +1,5 @@
+cache
+=====
+
+.. automodule:: afwf.example_wf.cache
+    :members:

docs/source/afwf/example_wf/handlers/__init__.rst

@@ -0,0 +1,14 @@
+handlers
+========
+
+.. automodule:: afwf.example_wf.handlers
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    python_version <python_version>
+

docs/source/afwf/example_wf/handlers/python_version.rst

@@ -0,0 +1,5 @@
+python_version
+==============
+
+.. automodule:: afwf.example_wf.handlers.python_version
+    :members:

docs/source/afwf/opt/__init__.rst

@@ -0,0 +1,16 @@
+opt
+===
+
+.. automodule:: afwf.opt
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    cache <cache/__init__>
+    fuzzy <fuzzy/__init__>
+    fuzzy_item <fuzzy_item/__init__>
+

docs/source/afwf/opt/cache/__init__.rst

@@ -0,0 +1,14 @@
+cache
+=====
+
+.. automodule:: afwf.opt.cache
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    impl <impl>
+

docs/source/afwf/opt/cache/impl.rst

@@ -0,0 +1,5 @@
+impl
+====
+
+.. automodule:: afwf.opt.cache.impl
+    :members:

docs/source/afwf/opt/fuzzy/__init__.rst

@@ -0,0 +1,14 @@
+fuzzy
+=====
+
+.. automodule:: afwf.opt.fuzzy
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    impl <impl>
+

docs/source/afwf/opt/fuzzy/impl.rst

@@ -0,0 +1,5 @@
+impl
+====
+
+.. automodule:: afwf.opt.fuzzy.impl
+    :members:

docs/source/afwf/opt/fuzzy_item/__init__.rst

@@ -0,0 +1,14 @@
+fuzzy_item
+==========
+
+.. automodule:: afwf.opt.fuzzy_item
+    :members:
+
+sub packages and modules
+------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    impl <impl>
+

docs/source/afwf/opt/fuzzy_item/impl.rst

@@ -0,0 +1,5 @@
+impl
+====
+
+.. automodule:: afwf.opt.fuzzy_item.impl
+    :members:

docs/source/conf.py

@@ -26,12 +26,14 @@
 import afwf as package
 
 package_name = package.__name__
+package_author = package.__author__
+package_version = package.__version__
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+
+# needs_sphinx = '5.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -45,10 +47,12 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
-    'sphinxcontrib.jinja',
+    'sphinx_jinja',
     'sphinx_copybutton',
-    'sphinx_inline_tabs',
+    'sphinx_design',
+    'sphinx_search.extension',
     'docfly.directives',
+    'nbsphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -65,24 +69,24 @@
 
 # General information about the project.
 project = package_name
-copyright = '{}, Sanhe Hu'.format(datetime.utcnow().year, package.__author__)
-author = package.__author__
+copyright = '{}, {}'.format(datetime.utcnow().year, package_author)
+author = package_author
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = package.__version__
+version = package_version
 # The full version, including alpha/beta/rc tags.
-release = package.__version__
+release = package_version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -238,10 +242,10 @@
     conf_file=__file__,
     package_name=package_name,
     ignored_package=[
-        "%s._version" % package_name,
-        "%s.pkg" % package_name,
         "%s.docs" % package_name,
         "%s.tests" % package_name,
-        "%s.example_wf" % package_name,
+        "%s.vendor" % package_name,
+        "%s._version" % package_name,
+        "%s.paths" % package_name,
     ]
 ).fly()