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
9 changes: 3 additions & 6 deletions .github/workflows/deploy-docs-prod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,8 @@ jobs:
with:
version: ${{ vars.QUARTO_VERSION }}

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Generate Python library docs
run: |
Expand All @@ -91,8 +89,7 @@ jobs:

- name: Generate template schema docs
run: |
pip install json-schema-for-humans
BACKEND_ROOT=site/_source/backend python scripts/generate_template_schema_docs.py
BACKEND_ROOT=site/_source/backend uv run --with json-schema-for-humans python scripts/generate_template_schema_docs.py

- name: Populate installation
run: cp -r site/_source/installation/site/installation site/installation
Expand Down
9 changes: 3 additions & 6 deletions .github/workflows/deploy-docs-staging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,8 @@ jobs:
with:
version: ${{ vars.QUARTO_VERSION }}

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Generate Python library docs
run: |
Expand All @@ -91,8 +89,7 @@ jobs:

- name: Generate template schema docs
run: |
pip install json-schema-for-humans
BACKEND_ROOT=site/_source/backend python scripts/generate_template_schema_docs.py
BACKEND_ROOT=site/_source/backend uv run --with json-schema-for-humans python scripts/generate_template_schema_docs.py

- name: Populate installation
run: cp -r site/_source/installation/site/installation site/installation
Expand Down
6 changes: 2 additions & 4 deletions .github/workflows/publish-llm-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,8 @@ jobs:
with:
version: ${{ vars.QUARTO_VERSION }}

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Generate Python library docs
run: |
Expand Down
11 changes: 4 additions & 7 deletions .github/workflows/validate-docs-site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ jobs:
src/backend/templates/documentation/model_documentation
sparse-checkout-cone-mode: true

- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Verify copyright headers
run: |
cd site
Expand All @@ -75,11 +78,6 @@ jobs:
with:
version: pre-release

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: Generate Python library docs
run: |
cd site/_source/validmind-library
Expand All @@ -91,8 +89,7 @@ jobs:

- name: Generate template schema docs
run: |
pip install json-schema-for-humans
BACKEND_ROOT=site/_source/backend python scripts/generate_template_schema_docs.py
BACKEND_ROOT=site/_source/backend uv run --with json-schema-for-humans python scripts/generate_template_schema_docs.py

- name: Populate installation
run: cp -r site/_source/installation/site/installation site/installation
Expand Down
15 changes: 7 additions & 8 deletions site/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ help:

add-copyright:
@echo "\nAdding copyright headers to .qmd and .yml/.yaml files ..."
@cd .. && python site/scripts/add_copyright.py
@cd .. && uv run python site/scripts/add_copyright.py

# Clean up source directory
clean:
Expand Down Expand Up @@ -337,9 +337,9 @@ notebooks:
@echo "Copying _metadata.yml into notebooks/ ..."
@cp developer/_metadata.yml $(DEST_DIR_NB)/_metadata.yml
@echo "Updating developer/_sidebar.yaml with use_cases directories ..."
@python scripts/developer-sidebar/update_use_cases.py
@uv run python scripts/developer-sidebar/update_use_cases.py
@echo "Updating developer/_sidebar.yaml with how-to directories ..."
@python scripts/developer-sidebar/update_how_tos.py
@uv run python scripts/developer-sidebar/update_how_tos.py
@echo "Zip up notebooks.zip ..."
@zip -r notebooks.zip $(DEST_DIR_NB) > /dev/null 2>&1

Expand Down Expand Up @@ -427,12 +427,11 @@ release-notes:
template-schema-docs:
@echo "\nGenerating template schema documentation ..."
@if [ ! -d "$(SRC_ROOT)/backend" ]; then echo "Error: Backend not cloned. Run 'make clone' first."; exit 1; fi
@python -m pip install -q json-schema-for-humans
@BACKEND_ROOT=$(SRC_ROOT)/backend python ../scripts/generate_template_schema_docs.py
@BACKEND_ROOT=$(SRC_ROOT)/backend uv run --with json-schema-for-humans python ../scripts/generate_template_schema_docs.py

test-descriptions:
@echo "\nUpdating test descriptions source ..."
@cd _source/validmind-library && make install && poetry run python scripts/extract_descriptions.py validmind/tests
@cd _source/validmind-library && make install && uv run python scripts/extract_descriptions.py validmind/tests
@cd ../../
@rm -rf $(DEST_DIR_TESTS)
@mkdir -p $(DEST_DIR_TESTS)
Expand All @@ -442,11 +441,11 @@ test-descriptions:

verify-copyright:
@echo "\nVerifying copyright headers in .qmd and .yml/.yaml files ..."
@cd .. && python site/scripts/verify_copyright_qmd.py
@cd .. && uv run python site/scripts/verify_copyright_qmd.py

# Collate yearly releases
yearly-releases:
@python ../release-scripts/yearly_cleanup.py
@uv run python ../release-scripts/yearly_cleanup.py
cd ../
git status | grep -v 'release-scripts/'
quarto preview
Expand Down