Add docs make flow#199
Draft
lfengad wants to merge 4 commits into
Draft
Conversation
Publish the existing README, benchmarks, cookbooks, and notebooks as a Material for MkDocs documentation site (search, sidebar nav, dark mode), matching the look of sites like NVlabs/Sana. - mkdocs.yml: Material theme + mkdocs-jupyter (renders cookbook notebooks) + mkdocs-same-dir (docs_dir at repo root, so no files are moved) - docs-requirements.txt: pinned, build-verified plugin versions - .github/workflows/docs.yml: build on push to main, deploy via the official Pages actions (no gh-pages branch) - .gitignore: ignore build output (/site/, .site/, .venv-docs/) Note: requires enabling Pages with the "GitHub Actions" source. Build is not --strict due to a pre-existing broken link in RELEASE.md. Co-Authored-By: Claude Opus 4.8 <[email protected]>
- branding/nvidia.css: NVIDIA green (#76b900) on headings, links, and the full left navigation index (all levels); dark-mode variants - branding/cosmos-logo-thumbnail.png: logo copy in a subdir, since the same-dir plugin drops non-Markdown files at the repo root (root logo 404'd) - mkdocs.yml: point logo/favicon at branding/, add extra_css, and enable toc.integrate so each page's table of contents renders in the left sidebar (the README's manual TOC is hidden on the site via CSS, kept for GitHub) Co-Authored-By: Claude Opus 4.8 <[email protected]>
- Add a pull_request trigger so the MkDocs build is verified on PRs; the deploy job is gated with `if: github.event_name != 'pull_request'`. - Add branding/** to the path filter so CSS/logo changes trigger a rebuild. Co-Authored-By: Claude Opus 4.8 <[email protected]>
setup-python's cache:pip only auto-detects requirements.txt/pyproject.toml; our deps file is docs-requirements.txt, so it failed with 'No file matched'. Set cache-dependency-path explicitly. Co-Authored-By: Claude Opus 4.8 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.