diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index b5c0f5fd62a1..49f6898092a5 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -65,7 +65,7 @@ See `docs/src/data/template/image-template.yml` for all available fields. ### Step 2: Regenerate ```bash -cd docs/src && python main.py --verbose +python docs/src/main.py --verbose ``` --- @@ -76,7 +76,7 @@ Add `ga` and `eop` fields to image configs for repositories that appear in suppo ```yaml ga: "2025-10-15" # General Availability date -eop: "2026-10-15" # End of Patch date +eop: "2035-10-15" # End of Patch date ``` **Version Consolidation:** @@ -229,4 +229,4 @@ For any changes required to the tutorial pages, create a new PR in | "Display name not found" | Add repository to `display_names` in `global.yml` | | "Inconsistent dates" | Ensure all images in same framework group/version have identical GA/EOP | | Images not appearing | Check repository is in `table_order` | -| Release notes not generating | Ensure `announcements` and `packages` fields are present | \ No newline at end of file +| Release notes not generating | Ensure `announcements` and `packages` fields are present | diff --git a/docs/README.md b/docs/README.md index ab46cddda5c3..3827f8ce8de7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,23 +18,23 @@ uv pip install -r docs/requirements.txt Run the generation system without serving: ```bash -cd docs/src && python main.py --verbose +python docs/src/main.py --verbose ``` This clones the `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories. Generation flags: ```bash -python main.py --available-images-only -python main.py --support-policy-only -python main.py --release-notes-only -python main.py --index-only +python docs/src/main.py --available-images-only +python docs/src/main.py --support-policy-only +python docs/src/main.py --release-notes-only +python docs/src/main.py --index-only ``` ### Serving Use `mkdocs serve` to generate documentation and serve the website: ```bash -cd docs && mkdocs serve +mkdocs serve ``` The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.