Merge pull request #12 from radical-cybertools/feature/docs_polish

Fix docs and refine

Author: AymenFJA

.github/workflows/docs.yml

@@ -2,7 +2,7 @@ name: Deploy Documentation
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, master, feature/docs_polish ]
   workflow_dispatch:
 
 permissions:

docs/LICENSE.md

@@ -0,0 +1,24 @@
+
+rhapsody is licensed under the MIT License (MIT)
+-----------------------------------------------------
+
+    Copyright (C) 2023 by the RADICAL-Cybertools Team
+    (info@radical-cybertools.org)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to
+    deal in the Software without restriction, including without limitation the
+    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    sell copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+    IN THE SOFTWARE.

docs/getting-started/index.md

@@ -14,4 +14,4 @@ Welcome to RHAPSODY! This section will guide you from installation to running yo
 
 ## Next Steps
 
-Once you've mastered the basics, you can explore the full **[API Reference](../api/)** for detailed module and class documentation.
+Once you've mastered the basics, you can explore the full **[API Reference](../api/index.md)** for detailed module and class documentation.

pyproject.toml

@@ -66,6 +66,9 @@ docs = [
     "mkdocs>=1.5.0",
     "mkdocs-material>=9.0.0",
     "mkdocstrings[python]>=0.24.0",
+    "mkdocs-gen-files>=0.5.0",
+    "mkdocs-literate-nav>=0.6.0",
+    "mkdocs-section-index>=0.3.0",
 ]
 ci = [
     "tox>=4.0.0",

src/rhapsody/api/task.py

@@ -21,6 +21,7 @@
 import threading
 from abc import ABC
 from abc import abstractmethod
+from collections.abc import Generator
 from typing import Any
 from typing import Callable
 
@@ -225,13 +226,13 @@ def bind_future(self, future: asyncio.Future) -> None:
         """
         self._future = future
 
-    def __await__(self):
+    def __await__(self) -> Generator[Any, None, Any]:
         """Allow the task object to be awaited directly.
 
         Delegates to the internal future.
 
         Returns:
-            An iterator for the task completion.
+            Generator[Any, None, Any]: An iterator for the task completion.
 
         Raises:
             RuntimeError: If future is not bound (task not submitted).

src/rhapsody/backends/execution/concurrent.py

@@ -291,7 +291,7 @@ async def __aexit__(self, exc_type, exc_val, exc_tb):
         await self.shutdown()
 
     @classmethod
-    async def create(cls, executor: Executor):
+    async def create(cls, executor: Executor) -> "ConcurrentExecutionBackend":
         """Alternative factory method for creating initialized backend.
 
         Args:

src/rhapsody/backends/execution/radical_pilot.py

@@ -12,6 +12,7 @@
 import os
 import threading
 from collections.abc import Generator
+from typing import Any
 from typing import Callable
 
 import typeguard
@@ -40,7 +41,7 @@ def _get_logger() -> logging.Logger:
     return logging.getLogger(__name__)
 
 
-def service_ready_callback(future: asyncio.Future, task, state) -> None:
+def service_ready_callback(future: asyncio.Future, task: Any, state: str) -> None:
     """Callback for handling service task readiness.
 
     Runs wait_info() in a daemon thread to avoid blocking execution flow.
@@ -638,7 +639,7 @@ def link_implicit_data_deps(self, src_task: dict, dst_task: dict) -> None:
         Args:
             src_task (Dict): Source task dictionary containing 'uid' key.
             dst_task (Dict): Destination task dictionary with
-            'task_backend_specific_kwargs' for pre_exec commands.
+                'task_backend_specific_kwargs' for pre_exec commands.
 
         Note:
             - Links all files from source sandbox except the task UID file itself

src/rhapsody/logger.py

@@ -21,13 +21,14 @@
 
 import logging
 import sys
+from typing import Any
 from typing import Optional
 
 
 def enable_logging(
     level: int = logging.INFO,
     format_string: Optional[str] = "%(asctime)s | %(levelname)-8s | [%(name)s] | %(message)s",
-    stream=None,
+    stream: Optional[Any] = None,
     force: bool = True,
 ) -> None:
     """Enable logging for RHAPSODY.