Add initial Sphinx documentation setup with API reference - #524
Closed
Chaitanya-Parab wants to merge 1 commit into
Closed
Add initial Sphinx documentation setup with API reference#524Chaitanya-Parab wants to merge 1 commit into
Chaitanya-Parab wants to merge 1 commit into
Conversation
Collaborator
Author
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
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.
Describe your changes
Description
Added an initial Sphinx-based documentation setup for the project:
Motivation & Context:
As the project grows, the current README-based documentation becomes harder to navigate. This change introduces a
structured and scalable documentation system, making it easier to maintain and extend documentation in the future.
Dependencies:
1. sphinx
2. sphinx-rtd-theme (optional for better UI)
Issue Link
Closes #61
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee