My work: documentation system setup (issue #61) - #501
Closed
sumit08kumar wants to merge 1 commit into
Closed
Conversation
Collaborator
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
This PR implements the foundational Sphinx documentation system for
neural-lam, as requested in Issue #61.Key Changes:
docs/conf.pywith 8 extensions (autodoc, napoleon, intersphinx, myst-parser, etc.) andsphinx-book-theme..rststubs for 8 core modules to auto-generate documentation from Python docstrings.getting_started.md,user_guide/data.md,user_guide/graphs.md,training.md,evaluation.md,contributing.md)..github/workflows/docs.ymlto validate documentation on every PR (warnings become errors)..readthedocs.yamlwith CPU-only PyTorch for automated staging and production deployment.Motivation and Context:
Currently, code documentation is buried in docstrings and the README has grown too large to navigate easily. This PR provides a searchable, versioned, and hyperlinked documentation website similar to PyTorch Geometric, making the project more accessible to researchers.
Dependencies:
Added
docsdependency group topyproject.tomlincluding:sphinx,sphinx-book-theme,myst-parser,sphinx-autodoc-typehints,sphinx-copybutton.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):
maintenance: implemented Sphinx documentation system with RTD and CI/CD validationChecklist for assignee