init docs

Author: geekwhocodes

docs/api/core.md

@@ -0,0 +1,3 @@
+# Core Engine
+
+::: pyspark_msgraph_source.core.async_interator

docs/api/index.md

@@ -0,0 +1,14 @@
+# API Reference
+
+Welcome to the API Reference of `your_package`.
+
+Below are the available modules and submodules:
+
+## Core
+- [Core Overview](core.md)
+
+## Utils
+- [Utils Helpers](utils.md)
+
+## API Client
+- [API Client](api_client.md)

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,18 @@
+site_name: Pyspark MSGraph Source
+theme:
+  name: material
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: ["src/"]  # or wherever your package code is
+          options:
+            show_source: true
+
+nav:
+  - Home: index.md
+  - API Reference:
+      - Overview: api/index.md
+      - Core: api/core.md

poetry.lock

@@ -35,6 +35,9 @@ grpcio-status = "^1.60.1"
 pandas = "^2.2.0"
 ipykernel = "^6.29.5"
 markdown = "^3.7"
+mkdocs = "^1.6.1"
+mkdocs-material = "^9.6.7"
+mkdocstrings = {extras = ["python"], version = "^0.28.2"}
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]