Skip to content
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
59 changes: 0 additions & 59 deletions .github/workflows/quarto-docs.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -227,5 +227,6 @@ my_tests/
docs/validmind.json
*.html
*.qmd

# DeepEval
*.deepeval/
8 changes: 5 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Generating Quarto Markdown for the Python API

This directory includes templates, macros, CSS, and Quarto Markdown output for generating the ValidMind Library (Python API) reference documentation for our docs site.
This directory includes templates, macros, and CSS for generating the ValidMind Library (Python API) reference documentation for our docs site.

- `templates/` — Jinja2 templates and macros for generating Quarto Markdown
- `validmind.css` — CSS for Python API reference styling
- `_metadata.yml` — Quarto configuration file
- `_sidebar.yml` — Generated sidebar navigation fragment for Quarto
- `validmind.qmd`, `validmind/` — Generated API documentation matching the codebase and pdoc structure
- `_sidebar.yml` — Generated sidebar navigation fragment for Quarto (NOT STORED IN THIS REPO)
- `validmind.qmd`, `validmind/` — Generated API documentation matching the codebase and pdoc structure (NOT STORED IN THIS REPO)

We no longer store the Quarto Markdown output in this repo, as it now gets generated on the fly when we build the docs site. You can still run `make quarto-docs` for debugging purposes.

## Testing locally

Expand Down
466 changes: 0 additions & 466 deletions docs/_sidebar.yml

This file was deleted.

595 changes: 0 additions & 595 deletions docs/validmind.qmd

This file was deleted.

17 changes: 0 additions & 17 deletions docs/validmind/datasets.qmd

This file was deleted.

14 changes: 0 additions & 14 deletions docs/validmind/datasets/classification.qmd

This file was deleted.

62 changes: 0 additions & 62 deletions docs/validmind/datasets/classification/customer_churn.qmd

This file was deleted.

31 changes: 0 additions & 31 deletions docs/validmind/datasets/classification/taiwan_credit.qmd

This file was deleted.

14 changes: 0 additions & 14 deletions docs/validmind/datasets/credit_risk.qmd

This file was deleted.

167 changes: 0 additions & 167 deletions docs/validmind/datasets/credit_risk/lending_club.qmd

This file was deleted.

Loading
Loading