Fix doc deployment / PR 4

Fix doc deployment

Author: gabor-openai

Makefile

@@ -2,10 +2,6 @@
 install:
 	npm install
 
-.PHONY: install-docs
-install-docs:
-	pip install -r requirements.txt
-
 .PHONY: format
 format: 
 	npm run format
@@ -28,7 +24,7 @@ sync:
 
 .PHONY: build-docs
 build-docs:
-	uv run mkdocs build
+	uv run mkdocs build --site-dir site
 
 .PHONY: serve-docs
 serve-docs:

mkdocs.yml

@@ -24,46 +24,32 @@ markdown_extensions:
 
 plugins:
   - search
-  - mkdocstrings:
-      handlers:
-        python:
-          paths: ["src"]
-          selection:
-            docstring_style: google
-          options:
-            signature_crossrefs: true
-            members_order: source
-            separate_signature: true
-            show_signature_annotations: true
-            heading_level: 3
-            inherited_members: true
   - i18n:
-      docs_structure: folder
+      default_language: en
       languages:
-        - locale: en
-          default: true
+        en:
           name: English
           build: true
-          nav:
-            - Intro: index.md
-            - Examples: examples.md
-            - Documentation:
-              - Quickstart: quickstart.md
-              - "Streaming vs Blocking": streaming_output.md
-              - Tripwires: tripwires.md
-              - Checks:
-                  - Prompt Injection Detection: ref/checks/prompt_injection_detection.md
-                  - Contains PII: ref/checks/pii.md
-                  - Custom Prompt Check: ref/checks/custom_prompt_check.md
-                  - Hallucination Detection: ref/checks/hallucination_detection.md
-                  - Jailbreak Detection: ref/checks/jailbreak.md
-                  - Moderation: ref/checks/moderation.md
-                  - Off Topic Prompts: ref/checks/off_topic_prompts.md
-                  - URL Filter: ref/checks/urls.md
-              - Evaluation Tool: evals.md
-            - API Reference:
-              - Types: ref/types-typescript.md
-              - Exceptions: ref/exceptions-typescript.md
+nav:
+  - Intro: index.md
+  - Examples: examples.md
+  - Documentation:
+    - Quickstart: quickstart.md
+    - "Streaming vs Blocking": streaming_output.md
+    - Tripwires: tripwires.md
+    - Checks:
+        - Prompt Injection Detection: ref/checks/prompt_injection_detection.md
+        - Contains PII: ref/checks/pii.md
+        - Custom Prompt Check: ref/checks/custom_prompt_check.md
+        - Hallucination Detection: ref/checks/hallucination_detection.md
+        - Jailbreak Detection: ref/checks/jailbreak.md
+        - Moderation: ref/checks/moderation.md
+        - Off Topic Prompts: ref/checks/off_topic_prompts.md
+        - URL Filter: ref/checks/urls.md
+    - Evaluation Tool: evals.md
+  - API Reference:
+    - Types: ref/types-typescript.md
+    - Exceptions: ref/exceptions-typescript.md
 
 extra:
   generator: false

pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "openai-guardrails-js-docs"
+version = "0.1.0"
+description = "Documentation for OpenAI Guardrails JS"
+requires-python = ">=3.9"
+dependencies = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.14",
+    "pymdown-extensions>=10.0.0",
+    "mkdocs-i18n>=0.4.3",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.14",
+    "pymdown-extensions>=10.0.0",
+    "mkdocs-i18n>=0.4.3",
+]