DSPy: The framework for programming—not prompting—language models
Python
Update build instructions and docusaurus deps cleanup for docs (#1815)
Herumb Shandilya83b29aade23c
diff --git a/docs/README.md b/docs/README.mdindex 54c70c173..faf7d6072 100644--- a/docs/README.md+++ b/docs/README.md@@ -1,6 +1,6 @@# DSPy Documentation-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.+This website is built using [Material for MKDocs](https://squidfunk.github.io/mkdocs-material/), a Material UI inspired theme for MKDocs.## Building docs locally@@ -13,21 +13,27 @@ To build and test the documentation locally:2. Install the necessary dependencies:```bash- npm install+ pip install -r requirements.txt```3. Run the build command:```bash- npm run build+ mkdocs build```-This will generate a static build of the documentation site in the `build` directory. You can then serve this directory to view the site locally. If you see the build failing make sure to fix it before pushing.+This will generate a static build of the documentation site in the `site` directory. You can then serve this directory to view the site locally using:++```bash+mkdocs serve+```++If you see the build failing make sure to fix it before pushing.## Continuous Integration (CI) Build ChecksWe have automated build checks set up in our CI pipeline to ensure the documentation builds successfully before merging changes. These checks:-1. Run the `npm run build` command+1. Run the `mkdocs build` command2. Verify that the build completes without errors3. Help catch potential issues early in the development processdiff --git a/docs/docs/blog/index.md b/docs/docs/blog/index.mddeleted file mode 100644index c58f16c50..000000000--- a/docs/docs/blog/index.md+++ /dev/null@@ -1,2 +0,0 @@-# Blog-diff --git a/docs/docs/deep-dive/_category_.json b/docs/docs/deep-dive/_category_.jsondeleted file mode 100644index 393adc8eb..000000000--- a/docs/docs/deep-dive/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Deep Dive",- "position": 5,- "link": {- "type": "generated-index",- "description": "DSPy introduces signatures (to abstract prompts), modules (to abstract prompting techniques), and optimizers that can tune the prompts (or weights) of modules."- }-}\ No newline at end of filediff --git a/docs/docs/deep-dive/data-handling/_category_.json b/docs/docs/deep-dive/data-handling/_category_.jsondeleted file mode 100644index fcac86b63..000000000--- a/docs/docs/deep-dive/data-handling/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Data Handling",- "position": 1,- "link": {- "type": "generated-index",- "description": "Data Handling in DSPy"- }-}\ No newline at end of filediff --git a/docs/docs/deep-dive/language_model_clients/_category_.json b/docs/docs/deep-dive/language_model_clients/_category_.jsondeleted file mode 100644index 6fe54c326..000000000--- a/docs/docs/deep-dive/language_model_clients/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Language Model Clients",- "position": 5,- "link": {- "type": "generated-index",- "description": "Language Model Clients in DSPy"- }-}\ No newline at end of filediff --git a/docs/docs/deep-dive/modules/_category_.json b/docs/docs/deep-dive/modules/_category_.jsondeleted file mode 100644index 3488b4208..000000000--- a/docs/docs/deep-dive/modules/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Modules",- "position": 3,- "link": {- "type": "generated-index",- "description": "Modules in DSPy"- }-}\ No newline at end of filediff --git a/docs/docs/deep-dive/optimizers/_category_.json b/docs/docs/deep-dive/optimizers/_category_.jsondeleted file mode 100644index 35f07a1e7..000000000--- a/docs/docs/deep-dive/optimizers/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Optimizers",- "position": 7,- "link": {- "type": "generated-index",- "description": "Optimizers are powerful constructs (included in DSPy) that can learn to bootstrap and select effective prompts for the modules of any program."- }-}\ No newline at end of filediff --git a/docs/docs/deep-dive/retrieval_models_clients/_category_.json b/docs/docs/deep-dive/retrieval_models_clients/_category_.jsondeleted file mode 100644index 4422ec12e..000000000--- a/docs/docs/deep-dive/retrieval_models_clients/_category_.json+++ /dev/null@@ -1,8 +0,0 @@-{- "label": "Retrieval Model Clients",- "position": 6,- "link": {- "type": "generated-index",- "description": "Retrieval Models in DSPy"- }-}\ No newline at end of filediff --git a/docs/mkdocs.yml b/docs/mkdocs.ymlindex ea682073d..18b7e9ea1 100644--- a/docs/mkdocs.yml+++ b/docs/mkdocs.yml@@ -102,7 +102,7 @@ plugins:- social- search- mkdocstrings- - blog+ # - blog- mkdocs-jupyter:ignore_h1_titles: True- redirects: