Add initial website #148
Merged
Add initial website #148
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive documentation website for the Iris multi-GPU programming framework. The website provides structured documentation including getting started guides, conceptual explanations, API references, and examples.
Key changes include:
- Addition of Sphinx-based documentation infrastructure with automated builds
- Comprehensive API documentation with improved docstrings
- Website structure with installation guides, programming model explanations, and examples
Reviewed Changes
Copilot reviewed 23 out of 33 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| iris/iris.py | Enhanced with comprehensive module and class docstrings for API documentation |
| iris/init.py | Added module-level documentation with framework overview |
| docs/ | Complete Sphinx documentation site with configuration, content, and build scripts |
| .readthedocs.yaml | ReadTheDocs configuration for external documentation hosting |
| .github/workflows/docs.yml | GitHub Actions workflow for automated documentation building and deployment |
|
@astroC86 I can't request your review but please check out the PR and feel free to leave comments. We would appreciate your input. |
|
looks very well done and polished! |
|
This is awesome 🎉 |
mawad-amd
commented
Sep 2, 2025
mawad-amd
commented
Sep 2, 2025
neoblizz
approved these changes
Sep 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Check deployment at https://mawad-amd.github.io/iris/
Technical Details
There are some duplicate documentation at the moment but I will leave that for later.
Test Plan
Test Result
Submission Checklist