Skip to content
Draft
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
1 change: 0 additions & 1 deletion .github/workflows/doc-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ jobs:
package: Microsoft-Azure
package_name: microsoft-azure
additional_args: --not_python_module
pre_command: cd Microsoft-Azure && make docs
secrets:
token: ${{ secrets.HUGGINGFACE_PUSH }}
hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
1 change: 0 additions & 1 deletion .github/workflows/doc-pr-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ jobs:
package: Microsoft-Azure
package_name: microsoft-azure
additional_args: --not_python_module
pre_command: cd Microsoft-Azure && make docs
36 changes: 1 addition & 35 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,47 +1,13 @@
.PHONY: install docs clean serve help

SERVICES := foundry machine-learning
.PHONY: install serve help

install:
@uv pip install hf-doc-builder requests watchdog

docs: clean
@$(foreach svc,$(SERVICES), \
echo "Creating docs/source/$(svc)/examples directory for examples/$(svc)..." && \
mkdir -p docs/source/$(svc)/examples && \
echo "Converting Jupyter Notebooks to MDX for $(svc)..." && \
doc-builder notebook-to-mdx examples/$(svc)/ && \
) true
@echo "Auto-generating example files for documentation..."
@python docs/scripts/auto-generate-examples.py
@$(foreach svc,$(SERVICES), \
echo "Cleaning up generated Markdown Notebook files for $(svc)..." && \
find examples/$(svc)/ -name "azure-notebook.md" -type f -delete && \
) true
@echo "Generating YAML tree structure and appending to _toctree.yml..."
@python docs/scripts/auto-update-toctree.py
@echo "YAML tree structure appended to docs/source/_toctree.yml"
@echo "Documentation setup complete."

clean:
@echo "Cleaning up generated documentation..."
@$(foreach svc,$(SERVICES), \
rm -rf docs/source/$(svc)/examples && \
) true
@awk '/# GENERATED CONTENT DO NOT EDIT/,/# END OF GENERATED CONTENT/{next} {print}' docs/source/_toctree.yml | sed -e :a -e '/^\n*$$/{$$d;N;ba' -e '}' > docs/source/_toctree.yml.tmp; mv docs/source/_toctree.yml.tmp docs/source/_toctree.yml
@echo "Cleaning up generated Markdown Notebook files (if any)..."
@$(foreach svc,$(SERVICES), \
find examples/$(svc) -name "azure-notebook.md" -type f -delete && \
) true
@echo "Cleanup complete."

serve:
@echo "Serving documentation via doc-builder"
doc-builder preview microsoft-azure docs/source --not_python_module

help:
@echo "Usage:"
@echo " make clean - Remove the auto-generated docs"
@echo " make docs - Auto-generate the examples for the docs"
@echo " make install - Install the required Python dependencies"
@echo " make serve - Serve the docs locally at http://localhost:5173"
126 changes: 0 additions & 126 deletions docs/scripts/auto-generate-examples.py

This file was deleted.

Loading
Loading