Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds initial Sphinx documentation for the Kale-Linear library and refreshes the README to provide clearer installation, usage examples, and development instructions.
Changes:
- Add a Sphinx docs skeleton (config, index/toctree, installation/usage pages, API reference via autodoc).
- Expand and modernize
README.md(features, quick-start examples, public API, dev workflow, docs build steps). - Update dependency lists and ignore generated docs build artifacts.
Reviewed changes
Copilot reviewed 9 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| requirements.txt | Adds tensorly to the top-level requirements list. |
| README.md | Rewrites README with installation, quick-start examples, and development/docs build instructions. |
| docs/source/index.rst | Adds documentation landing page and toctree. |
| docs/source/installation.rst | Adds installation instructions for PyPI/dev and docs build steps. |
| docs/source/usage.rst | Adds usage examples for transformers and estimators. |
| docs/source/api.rst | Adds autodoc-based API reference for main classes. |
| docs/source/conf.py | Adds Sphinx configuration and an autodoc skip hook for sklearn metadata-routing helpers. |
| docs/requirements.txt | Adds docs build requirements. |
| docs/Makefile | Adds make html/clean/help for Sphinx builds on Unix-like systems. |
| docs/make.bat | Adds Sphinx build helper for Windows. |
| docs/source/_templates/.gitkeep | Ensures templates directory exists in git. |
| docs/source/_static/.gitkeep | Ensures static directory exists in git. |
| .gitignore | Ignores generated docs build output and generated API stubs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+3
| nbsphinx | ||
| nbsphinx-link | ||
| sphinx |
Member
Author
There was a problem hiding this comment.
Removed nbsphinx and nbsphinx-link
| pre-commit run --all-files | ||
| ``` | ||
|
|
||
| 3. Run tests cases to verify functionality: |
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.
Add a Sphinx docs and update
README.md