Merge branch 'main' into v0.6.8-release

Author: CalebCourier

.github/workflows/ci.yml

@@ -37,13 +37,7 @@ jobs:
           # Setup Virtual Environment
           python3 -m venv ./.venv
           source .venv/bin/activate
-          
-          if [ "${{ matrix.python-version }}" == "3.9" ]; 
-            then
-              pip install .[dev]
-            else
-              poetry install --extras dev
-          fi
+          make dev
 
       - name: Check license
         run: |
@@ -70,12 +64,7 @@ jobs:
           # Setup Virtual Environment
           python3 -m venv ./.venv
           source .venv/bin/activate
-          if [ "${{ matrix.python-version }}" == "3.9" ]; 
-            then
-              pip install .[dev]
-            else
-              make dev          
-          fi
+          make dev
 
       - name: Lint with ruff
         run: |
@@ -102,12 +91,7 @@ jobs:
           # Setup Virtual Environment
           python3 -m venv ./.venv
           source .venv/bin/activate
-          if [ "${{ matrix.python-version }}" == "3.9" ]; 
-            then
-              pip install .[dev,sql,vectordb,manifest,anthropic,huggingface,api,databricks,uv,llama]
-            else
-              make full          
-          fi
+          make full
 
       - name: Static analysis with pyright
         run: |
@@ -144,12 +128,7 @@ jobs:
           python3 -m venv ./.venv
           source .venv/bin/activate
           
-          if [ "${{ matrix.python-version }}" == "3.9" ]; 
-            then
-              pip install .[dev,sql,vectordb,manifest,anthropic,huggingface,api,databricks,uv,llama]
-            else
-              make full          
-          fi
+          make full
           
           if [ "${{ matrix.python-version }}" == "3.12" ]; then
             echo "Installing latest langchain-core and langsmith from PyPI"

.github/workflows/cli-compatibility.yml

@@ -39,11 +39,7 @@ jobs:
           source .venv/bin/activate
           
           # Install dev dependencies
-          if [ "${{ matrix.python-version }}" == "3.9" ]; then
-            pip install .[dev]
-          else
-            poetry install --extras dev
-          fi
+          poetry install --extras dev
           
           # Install specific typer and click versions
           pip install typer==${{ matrix.typer-version }} click==${{ matrix.click-version }}

.github/workflows/scripts/run_notebooks.sh

@@ -5,7 +5,7 @@ export NLTK_DATA=/tmp/nltk_data;
 rm -rf ./guardrails
 
 # Navigate to notebooks
-cd docs/examples
+cd docs/src/examples
 
 # Get the notebook name from the matrix variable
 notebook="$1"

.github/workflows/scripts/update_notebook_matrix.sh

@@ -3,7 +3,7 @@
 notebook_names="["
 
 # Compile list of file names
-for file in $(ls docs/examples/*.ipynb); do
+for file in $(ls docs/src/examples/*.ipynb); do
   # Add the full filename with extension
   filename=$(basename "$file")
 

.gitignore

@@ -1,4 +1,3 @@
-docs/api_reference_markdown/
 openai_api_key.txt
 *__pycache__*
 data/*
@@ -14,7 +13,9 @@ settings.json
 site/*
 guardrails.log
 guardrails_ai.egg-info/
-build/*
+*/build/*
+docs/build
+!docs/dist/*
 dist/*
 *.rail_output*
 .idea/*
@@ -27,9 +28,8 @@ test.index
 htmlcov
 node_modules
 .docusaurus
-docs-build
 .vercel
-docusaurus/examples-toc.json
+!docs/examples-toc.json
 .python-version
 static/docs
 docusaurus/static/docs
@@ -41,4 +41,4 @@ docusaurus/static/docs
 */share/*
 pyvenv.cfg
 mlruns
-mlartifacts
+mlartifacts

DOCS.md

@@ -30,17 +30,17 @@ npm run start
 ## How the build process works
 
 1. pydocs is used to create python docs in the 'docs/' directory
-1. a new folder called 'docs-build' is created
-1. docs are copied from 'docs/' to 'docs-build/'
-1. nbdocs is used on all notebooks in the 'docs-build' directory. This creates md files parallel to the notebooks in the dir structure.
+1. a new folder called 'docs/build' is created
+1. docs are copied from 'docs/src' to 'docs/build'
+1. nbdocs is used on all notebooks in the 'docs/build' directory. This creates md files parallel to the notebooks in the dir structure.
 1. md files are iterated and converted to mdx files. We import some custom components at the top of each mdx file.
 
 ## Troubleshooting/common problems
 
 1. On first run, the docs build does not complete and the site is not served
     - This is usually an intermittent failure with nb-docs. Try running `npm run start` again
-    - If this doesn't work, try running `rm -rf docs-build; npm run start`
+    - If this doesn't work, try running `rm -rf docs/build; npm run start`
     - If even that doesn't work, please file an issue. Something may be wrong with docs builds on the branch
 1. I updated a notebook and it didn't update in the docs
     - This is likely because the notebook wasn't converted to markdown, or files were not overwritten
-    - To fix this, run `rm -rf docs-build; npm run start`
+    - To fix this, run `rm -rf docs/build; npm run start`

Makefile

@@ -45,8 +45,8 @@ full:
 
 docs-gen:
 	poetry run python ./docs/pydocs/generate_pydocs.py
-	cp -r docs docs-build
-	poetry run nbdoc_build --force_all True --srcdir ./docs-build
+	cp -r docs/src/* docs/dist
+	poetry run nbdoc_build --force_all True --srcdir ./docs/dist
 
 self-install:
 	pip install -e .

README.md

@@ -1,7 +1,7 @@
 <div align="center">
 
-<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/img/Guardrails-ai-logo-for-dark-bg.svg#gh-dark-mode-only" alt="Guardrails AI Logo" width="600px">
-<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/img/Guardrails-ai-logo-for-white-bg.svg#gh-light-mode-only" alt="Guardrails AI Logo" width="600px">
+<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/dist/img/Guardrails-ai-logo-for-dark-bg.svg#gh-dark-mode-only" alt="Guardrails AI Logo" width="600px">
+<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/dist/img/Guardrails-ai-logo-for-white-bg.svg#gh-light-mode-only" alt="Guardrails AI Logo" width="600px">
 
 <hr>
 
@@ -30,7 +30,7 @@ Guardrails is a Python framework that helps build reliable AI applications by pe
 
 
 <div align="center">
-<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/img/with_and_without_guardrails.svg" alt="Guardrails in your application" width="1500px">
+<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/dist/img/with_and_without_guardrails.svg" alt="Guardrails in your application" width="1500px">
 </div>
 
 
@@ -39,7 +39,7 @@ Guardrails is a Python framework that helps build reliable AI applications by pe
 Guardrails Hub is a collection of pre-built measures of specific types of risks (called 'validators'). Multiple validators can be combined together into Input and Output Guards that intercept the inputs and outputs of LLMs. Visit [Guardrails Hub](https://hub.guardrailsai.com/) to see the full list of validators and their documentation.
 
 <div align="center">
-<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/img/guardrails_hub.gif" alt="Guardrails Hub gif" width="600px">
+<img src="https://raw.githubusercontent.com/guardrails-ai/guardrails/main/docs/dist/img/guardrails_hub.gif" alt="Guardrails Hub gif" width="600px">
 </div>