chore: update documentation generation

Author: makkus

.github/workflows/build-linux.yaml

@@ -215,7 +215,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - run: git config --global user.email "markus@frkl.io"
+    - run: git config --global user.email "markus@frkl.dev"
     - run: git config --global user.name "Markus Binsteiner"
     - name: extract tag name
       run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV

AUTHORS.rst

@@ -2,4 +2,4 @@
 Contributors
 ============
 
-* Markus Binsteiner <markus@frkl.io>
+* Markus Binsteiner <markus@frkl.dev>

mkdocs.yml

@@ -64,7 +64,7 @@ plugins:
      - kiara.doc.mkdocs_macros_kiara
 - gen-files:
     scripts:
-#      - scripts/documentation/gen_info_pages.py
+      - scripts/documentation/gen_info_pages.py
       - scripts/documentation/gen_api_doc_pages.py
 - literate-nav:
     nav_file: SUMMARY.md

pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "hatchling.build"
 name = "kiara"
 description = "Data-centric workflow orchestration."
 authors = [
-    { name = "Markus Binsteiner", email = "markus@frkl.io" }
+    { name = "Markus Binsteiner", email = "markus@frkl.dev" }
 ]
 readme = "README.md"
 requires-python = ">=3.9"
@@ -232,7 +232,14 @@ dev_utils = [
     "types-networkx",
     "sqlalchemy-stubs",
     "watchdog",
-    "wheel"
+    "wheel",
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    "mkdocs-gen-files",
+    "mkdocs-literate-nav",
+    "mkdocs-macros-plugin",
+    "mkdocs-section-index",
+    "mike"
 ]
 
 jupyter = [

scripts/documentation/gen_info_pages.py

@@ -2,14 +2,15 @@
 
 import builtins
 
-from kiara.context import Kiara, KiaraContextInfo
+from kiara.context import KiaraContextInfo
 from kiara.doc.gen_info_pages import generate_detail_pages
+from kiara.interfaces.python_api.kiara_api import KiaraAPI
 
 pkg_name = "kiara"
 
-kiara: Kiara = Kiara.instance()
+kiara: KiaraAPI = KiaraAPI.instance()
 context_info = KiaraContextInfo.create_from_kiara_instance(
-    kiara=kiara, package_filter=pkg_name
+    kiara=kiara._api.context, package_filter=pkg_name
 )
 
 generate_detail_pages(

src/kiara/__init__.py

@@ -76,7 +76,7 @@ def DBG(
         flush: bool = False,
     ):
         objs = (
-            ["[green]----------------------------------------------[/green]"]  # noqa
+            ["[green]----------------------------------------------[/green]"]
             + list(objects)
             + ["[green]----------------------------------------------[/green]"]
         )
@@ -100,7 +100,7 @@ def DBG(
 
 __author__ = """Markus Binsteiner"""
 """The author of this package."""
-__email__ = "markus@frkl.io"
+__email__ = "markus@frkl.dev"
 """Email address of the author."""
 
 

src/kiara/doc/mkdocstrings/handler.py

@@ -6,7 +6,7 @@
 
 import typing
 
-from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem
+from mkdocstrings import BaseHandler, CollectionError, CollectorItem
 
 __all__ = ["get_handler"]
 
@@ -54,6 +54,8 @@ def collect(
         -------
             The collected object-tree.
         """
+        import builtins
+
         tokens = identifier.split(".")
 
         if tokens[0] != "kiara_info":
@@ -64,14 +66,15 @@ def collect(
         if not item_id:
             raise CollectionError(f"Invalid id: {identifier}")
 
-        ctx: KiaraContextInfo = builtins.plugin_package_context_info  # type: ignore  # noqa
+        ctx: KiaraContextInfo = builtins.plugin_package_context_info  # type: ignore
         try:
             item: ItemInfo = ctx.get_info(item_type=item_type, item_id=item_id)
         except Exception as e:
             log_exception(e)
             raise CollectionError(f"Invalid id: {identifier}")
 
-        return {"obj": item, "identifier": identifier}
+        result = {"obj": item, "identifier": identifier}
+        return result
 
     def get_anchors(self, data: CollectorItem) -> typing.Tuple[str, ...]:
         if data is None:
@@ -91,8 +94,11 @@ def render(
 
 def get_handler(
     theme: str,
-    custom_templates: typing.Union[str, None] = None,
-    config_file_path: typing.Union[None, str] = None,
+    custom_templates: typing.Union[str, None],
+    mdx: typing.List[str],
+    mdx_config: typing.Dict,
+    handler_config: typing.Dict,
+    tool_config: typing.Dict,
 ) -> KiaraHandler:
     """
     Simply return an instance of `PythonHandler`.

tests/resources/archives/nand_true.0.10.kiarchive.json

@@ -1 +1 @@
-{"type_name":"nand_true.0.10.kiarchive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"data_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_data_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteDataArchive","python_module_name":"kiara.registries.data.data_store.sqlite_store","full_name":"kiara.registries.data.data_store.sqlite_store.SqliteDataArchive"},"is_writable":false,"supported_item_types":["data"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_values":6,"value_ids":["2ed7942b-3719-4102-b42f-134a42969945","468dd2b4-0e0c-46f5-9def-05aa57396f46","4c929a5b-c91a-449e-9d5f-f21124298ea7","5668b4ae-a867-4238-bb34-be79115ff36e","60d0a0b3-1030-40c4-8c51-247fea623d83","7b7cd80a-8acd-4543-aa18-7e27ee124a70"],"dynamic_archive":false,"size":126976},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"alias_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_alias_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteAliasArchive","python_module_name":"kiara.registries.aliases.sqlite_store","full_name":"kiara.registries.aliases.sqlite_store.SqliteAliasArchive"},"is_writable":false,"supported_item_types":["alias"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_aliases":1,"aliases":["y"],"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"metadata_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_metadata_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteMetadataArchive","python_module_name":"kiara.registries.metadata.metadata_store.sqlite_store","full_name":"kiara.registries.metadata.metadata_store.sqlite_store.SqliteMetadataArchive"},"is_writable":false,"supported_item_types":["metadata"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_metadata_items":4,"no_references":1,"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"job_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_job_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteJobArchive","python_module_name":"kiara.registries.jobs.job_store.sqlite_store","full_name":"kiara.registries.jobs.job_store.sqlite_store.SqliteJobArchive"},"is_writable":false,"supported_item_types":["job_record"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_job_records":4,"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}}}
+{"type_name":"nand_true.0.10.kiarchive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"data_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_data_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteDataArchive","python_module_name":"kiara.registries.data.data_store.sqlite_store","full_name":"kiara.registries.data.data_store.sqlite_store.SqliteDataArchive"},"is_writable":false,"supported_item_types":["data"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_values":6,"value_ids":["2ed7942b-3719-4102-b42f-134a42969945","468dd2b4-0e0c-46f5-9def-05aa57396f46","4c929a5b-c91a-449e-9d5f-f21124298ea7","5668b4ae-a867-4238-bb34-be79115ff36e","60d0a0b3-1030-40c4-8c51-247fea623d83","7b7cd80a-8acd-4543-aa18-7e27ee124a70"],"dynamic_archive":false,"size":126976},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"alias_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_alias_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteAliasArchive","python_module_name":"kiara.registries.aliases.sqlite_store","full_name":"kiara.registries.aliases.sqlite_store.SqliteAliasArchive"},"is_writable":false,"supported_item_types":["alias"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_aliases":1,"aliases":["y"],"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"metadata_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_metadata_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteMetadataArchive","python_module_name":"kiara.registries.metadata.metadata_store.sqlite_store","full_name":"kiara.registries.metadata.metadata_store.sqlite_store.SqliteMetadataArchive"},"is_writable":false,"supported_item_types":["metadata"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_metadata_items":4,"no_references":1,"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}},"job_archive_info":{"type_name":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[]},"context":{"references":{},"tags":[],"labels":{}},"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_alias":"nand_true.0.10","archive_type_info":{"type_name":"sqlite_job_archive","documentation":{"description":"-- n/a --","doc":null},"authors":{"authors":[{"name":"Markus Binsteiner","email":"[email protected]"}]},"context":{"references":{"source_repo":{"url":"https://github.com/DHARPA-Project/kiara","desc":"The kiara project git repository."},"documentation":{"url":"https://dharpa.org/kiara_documentation/","desc":"The url for kiara documentation."}},"tags":[],"labels":{"package":"kiara"}},"python_class":{"python_class_name":"SqliteJobArchive","python_module_name":"kiara.registries.jobs.job_store.sqlite_store","full_name":"kiara.registries.jobs.job_store.sqlite_store.SqliteJobArchive"},"is_writable":false,"supported_item_types":["job_record"]},"config":{"sqlite_db_path":"/home/markus/projects/kiara/kiara/tests/resources/archives/nand_true.0.10.kiarchive","use_wal_mode":false},"details":{"no_job_records":4,"dynamic_archive":false},"metadata":{"archive_id":"1df47c50-058f-4f7a-8cdc-4ccab0ab1da9","archive_name":"nand_true.0.10"}}}