pulled doc requirements out of package

Author: steven10a

Makefile

@@ -2,6 +2,10 @@
 install:
 	npm install
 
+.PHONY: install-docs
+install-docs:
+	pip install -r requirements.txt
+
 .PHONY: format
 format: 
 	npm run format
@@ -20,8 +24,8 @@ build:
 
 .PHONY: build-docs
 build-docs:
-	npm run docs:build
+	mkdocs build
 
 .PHONY: serve-docs
 serve-docs:
-	npm run docs:serve
+	mkdocs serve

mkdocs.yml

@@ -1,19 +1,13 @@
 site_name: OpenAI Guardrails TypeScript
-site_dir: ../frontend/public/docs
+site_dir: .vercel/output/static
 theme:
   name: material
   features:
-    # Allows copying code blocks
     - content.code.copy
-    # Allows selecting code blocks
     - content.code.select
-    # Shows the current path in the sidebar
     - navigation.path
-    # Shows sections in the sidebar
     - navigation.sections
-    # Shows sections expanded by default
     - navigation.expand
-    # Enables annotations in code blocks
     - content.code.annotate
   palette:
     primary: black
@@ -36,17 +30,11 @@ plugins:
           selection:
             docstring_style: google
           options:
-            # Shows links to other members in signatures
             signature_crossrefs: true
-            # Orders members by source order, rather than alphabetical
             members_order: source
-            # Puts the signature on a separate line from the member name
             separate_signature: true
-            # Shows type annotations in signatures
             show_signature_annotations: true
-            # Makes the font sizes nicer
             heading_level: 3
-            # Show inherited members
             inherited_members: true
   - i18n:
       docs_structure: folder
@@ -75,8 +63,8 @@ plugins:
             - API Reference:
               - Types: ref/types-typescript.md
               - Exceptions: ref/exceptions-typescript.md
+
 extra:
-  # Remove material generation message in footer
   generator: false
   language: en
 

package.json

@@ -24,8 +24,6 @@
         "cli": "node dist/cli.js",
         "eval": "node dist/cli.js eval",
         "eval:example": "node dist/examples/run-eval.js",
-        "docs:build": "mkdocs build",
-        "docs:serve": "mkdocs serve"
     },
     "keywords": [
         "guardrails",
@@ -55,9 +53,6 @@
         "@typescript-eslint/eslint-plugin": "^6.0.0",
         "@typescript-eslint/parser": "^6.0.0",
         "eslint": "^8.0.0",
-        "mkdocs": "^1.5.3",
-        "mkdocs-material": "^9.5.3",
-        "mkdocs-mkdocstrings": "^0.24.0",
         "prettier": "^3.0.0",
         "rimraf": "^5.0.0",
         "typescript": "^5.0.0",

requirements.txt

@@ -0,0 +1,3 @@
+mkdocs==1.5.3
+mkdocs-material==9.5.3
+mkdocs-mkdocstrings==0.24.0

vercel.json

@@ -0,0 +1,13 @@
+{
+  "buildCommand": "pip install -r requirements.txt && mkdocs build",
+  "outputDirectory": ".vercel/output/static",
+  "framework": "other",
+  "installCommand": "echo 'Skipping npm install'",
+  "routes": [
+    {
+      "src": "/(.*)",
+      "dest": "/$1",
+      "continue": true
+    }
+  ]
+}