Sign in to like and favorite skills
If you're looking to understand the framework, please go to the DSPy Docs at dspy.ai
The content below is focused on how to modify the documentation site.
This website is built using Material for MKDocs, a Material UI inspired theme for MKDocs.
To build and test the documentation locally:
Navigate to the
docscd docs
Install the necessary dependencies:
pip install -r requirements.txt
In docs/ directory, run the command below to generate the API docs and index them:
python scripts/generate_api_docs.py python scripts/generate_api_summary.py
(Optional) On MacOS you may also need to install libraries for building the site
brew install cairo freetype libffi libjpeg libpng zlib export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib
Run the build command:
mkdocs build
This will generate a static build of the documentation site in the
sitemkdocs serve
If you see the build failing make sure to fix it before pushing.
We have automated build checks set up in our CI pipeline to ensure the documentation builds successfully before merging changes. These checks:
mkdocs buildIf the CI build check fails, please review your changes and ensure the documentation builds correctly locally before pushing updates.
docsThis guide is for contributors looking to make changes to the documentation in the
dspy/docsPull the up-to-date version of the website: Please pull the latest version of the live documentation site via cloning the dspy repo. The current docs are in the
dspy/docsPush your new changes on a new branch: Feel free to add or edit existing documentation and open a PR for your changes. Once your PR is reviewed and approved, the changes will be ready to merge into main.
Updating the website: Once your changes are merged to main, the changes would be reflected on live websites usually in 5-15 mins.
The build process generates an
/llms.txtmkdocs.ymlllmstxt