work-in-progress

Author: shamrin

README.md

@@ -132,13 +132,12 @@ Run it:
 uv run python example.py
 ```
 
-### Generating the documentation
+### Previewing the documentation
 
 If added a new service, create a documentation template under api/services for that service.
 
 ```bash
-cd docs
-make html
+uv run mkdocs serve
 ```
 
 ### Code style

docs/Makefile

@@ -0,0 +1,52 @@
+# Verda Python SDK
+
+Welcome to the documentation for the official Verda (formerly Datacrunch) Python SDK.
+
+The Public API documentation is [available here](https://api.verda.com/v1/docs)
+
+The Python SDK is open-sourced and can be [found here](https://github.com/verda-cloud/sdk-python)
+
+## Basic Examples:
+
+First, get your client credentials - [instructions available here](https://api.verda.com/v1/docs#description/quick-start-guide).
+
+Deploy a new instance:
+
+```python
+import os
+from verda import VerdaClient
+
+# Get client secret from environment variable
+CLIENT_SECRET = os.environ['VERDA_CLIENT_SECRET']
+CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi'  # Replace with your client ID
+
+# Create client
+verda = VerdaClient(CLIENT_ID, CLIENT_SECRET)
+
+# Get all SSH keys id's
+ssh_keys = verda.ssh_keys.get()
+ssh_keys_ids = list(map(lambda ssh_key: ssh_key.id, ssh_keys))
+
+# Create a new instance
+instance = verda.instances.create(instance_type='1V100.6V',
+                                  image='ubuntu-24.04-cuda-12.8-open-docker',
+                                  ssh_key_ids=ssh_keys_ids,
+                                  hostname='example',
+                                  description='example instance')
+```
+
+List all existing instances, ssh keys, startup scripts:
+
+```python
+instances = verda.instances.get()
+keys = verda.ssh_keys.get()
+scripts = verda.startup_scripts.get()
+```
+
+List all available instance & image types (information about available
+os images and instances to deploy)
+
+```python
+instance_types = verda.instance_types.get()
+images_types = verda.images.get()
+```

docs/index.md

@@ -0,0 +1,57 @@
+site_name: Python SDK
+site_url: https://docs.your-internal-domain.com
+repo_url: https://github.com/verda-cloud/sdk-python
+repo_name: verda-cloud/sdk-python
+
+extra_css:
+  - stylesheets/extra.css
+
+theme:
+  name: material
+  logo: logo_darkmode.svg
+  palette: 
+    # Auto-switch to dark mode based on system preference
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+  features:
+    - content.code.annotate 
+    - content.tabs.link
+    - navigation.indexes
+    - navigation.sections
+    - search.suggest
+    - search.highlight
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [.] # Ensure this points to where your 'verda' package is located
+          options:
+            # Common options to match Sphinx autodoc behavior
+            show_source: true
+            show_root_heading: true
+            show_category_heading: true
+
+# Explicit Navigation Map (Replaces toctree)
+nav:
+  - Home: index.md
+  - Installation: installation.md
+  - Examples: examples.md
+  - API Reference:
+      - Client: reference/client.md
+      - Exceptions: reference/exceptions.md
+      - Constants: reference/constants.md
+      # Add your services manually here
+      - Services: reference/services.md 
+  - Contributing: contributing.md
+  - Changelog: changelog.md
+
+markdown_extensions:
+  # This enables proper styling for fenced code blocks ```python
+  - pymdownx.superfences
+  
+  # Optional: enables syntax highlighting for inline code `like this`
+  - pymdownx.inlinehilite

docs/make.bat

@@ -32,6 +32,11 @@ dev = [
     "responses>=0.25.8",
     "ruff>=0.14.2",
 ]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.0",
+    "mkdocstrings[python]>=1.0.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/verda-cloud"