Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update build instructions and docusaurus deps cleanup for docs #1815

Merged
merged 1 commit into from
Nov 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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 Checks

We 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` command
2. Verify that the build completes without errors
3. Help catch potential issues early in the development process

Expand Down
2 changes: 0 additions & 2 deletions docs/docs/blog/index.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/data-handling/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/language_model_clients/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/modules/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/optimizers/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/deep-dive/retrieval_models_clients/_category_.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ plugins:
- social
- search
- mkdocstrings
- blog
# - blog
- mkdocs-jupyter:
ignore_h1_titles: True
- redirects:
Expand Down
Loading