Skip to content

January release notes for developer framework #151

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

Merged
merged 24 commits into from
Jan 27, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ To follow the Quickstart, you need access to ONE of the following:
- [Google Colaboratory (Colab)](try-developer-framework-with-colab.qmd)
- [Docker Desktop](try-developer-framework-with-docker.qmd)

To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.

<!--- If you download the sample notebooks from Colab, [sample Jupyter notebooks](samples-jupyter-notebooks.qmd), for use To use ourlocally requires Python 3.8+. --->
To run our sample Jupyter notebooks locally, your developer environment must support **Python {{< var python-version >}}**.

### Access to ValidMind's Web UI

Expand Down
18 changes: 11 additions & 7 deletions site/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -52,22 +52,26 @@ notebooks:
# Make Python library docs & copy them over
python-docs:
@echo "\nUpdating Python documentation ..."
rm -rf $(DEST_DIR_PYTHON)
mkdir -p $(DEST_DIR_PYTHON)
cp -r $(SRC_DIR)/docs/_build/. $(DEST_DIR_PYTHON)
@rm -rf $(DEST_DIR_PYTHON)
@mkdir -p $(DEST_DIR_PYTHON)
@cp -r $(SRC_DIR)/docs/_build/. $(DEST_DIR_PYTHON)

test-descriptions:
@echo "\nUpdating test descriptions source ..."
rm -rf $(DEST_DIR_TESTS)
mkdir -p $(DEST_DIR_TESTS)
cp -r $(SRC_DIR)/build/_test_descriptions/validmind/tests/. $(DEST_DIR_TESTS)
@cd _source/developer-framework && poetry run python scripts/extract_descriptions.py validmind/tests
@cd ../../
@rm -rf $(DEST_DIR_TESTS)
@mkdir -p $(DEST_DIR_TESTS)
@cp -r $(SRC_DIR)/build/_test_descriptions/validmind/tests/. $(DEST_DIR_TESTS)

# Get all source files
get-source: clean clone notebooks python-docs test-descriptions

# Get all source files
docs-site: clean clone notebooks python-docs test-descriptions
quarto render
# quarto render notebooks/how_to/explore_tests.ipynb --execute
# quarto render notebooks/how_to/explore_test_suites.ipynb --execute

# Deployment to https://docs-demo.vm.validmind.ai/
deploy-demo:
Expand All @@ -85,4 +89,4 @@ deploy-prod:
# Generate release notes
release-notes:
@echo "\nGenerating release notes ..."
python generate_release_notes.py
@python generate_release_notes.py
4 changes: 3 additions & 1 deletion site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ website:
file: guide/join-closed-beta.qmd
- text: "Releases"
contents:
- text: "January 26, 2024"
file: releases/2024-jan-26/highlights.qmd
- text: "January 18, 2024"
file: releases/2024-jan-18/highlights.qmd
- text: "December 13, 2023"
Expand Down Expand Up @@ -233,7 +235,7 @@ website:

page-footer:
background: "#DE257E"
left: "_© Copyright 2023 ValidMind Inc All Rights Reserved._"
left: "_© Copyright 2023-24 ValidMind Inc All Rights Reserved._"
right:
- text: "validmind.com {{< fa external-link >}}"
href: https://validmind.com/
Expand Down
Loading