DOC Add intersphinx linking to docs #97
Merged
Conversation
This file contains 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
With this extension, skops docs can link, for instance, to the sklearn docs. On top of adding the extension, I made the following changes: - Adjust links to external docs where appropriate - Fix minor issues I found in the docs - Remove autodocs for type annotations, as they were redundant with the docstrings (but less detailed)
|
@skops-dev/maintainers Ready for review. Built docs are here. |
adrinjalali
approved these changes
Aug 12, 2022
There was a problem hiding this comment.
Nice refinements. Merging, more fixes (if any) can be added later. Thanks @BenjaminBossan
| "sklearn": ("https://scikit-learn.org/stable/", None), | ||
| "pandas": ("https://pandas.pydata.org/docs/", None), | ||
| "joblib": ("https://joblib.readthedocs.io/en/latest/", None), | ||
| "huggingface_hub": ("https://huggingface.co/docs/huggingface_hub/main/en", None), |
There was a problem hiding this comment.
Yes, it works indeed :)
See here, at the bottom the link to huggingface_hub.snapshot_download
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.
Fixes #93
With this extension, skops docs can link, for instance, to the sklearn
docs.
On top of adding the extension, I made the following changes:
docstrings (but less detailed)