Skip to content

Commit

Permalink
DOC: Enable intersphinx mapping to sklearn
Browse files Browse the repository at this point in the history
Sphinks reads the public methods of all classes, and if one inherits from
sklearn, it reads that method's docstring.  If that method contains a relative
link in the rst, sphinx needs to know where to link it.
  • Loading branch information
Jacob-Stevens-Haas committed Jul 4, 2023
1 parent ac61b4a commit 05c7c93
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
html_sourcelink_suffix = ""

intersphinx_mapping = {
"derivative": ("https://derivative.readthedocs.io/en/latest/", None)
"derivative": ("https://derivative.readthedocs.io/en/latest/", None),
"sklearn": ("https://scikit-learn.org/stable/", None),
}

# -- Extensions to the Napoleon GoogleDocstring class ---------------------
Expand Down

0 comments on commit 05c7c93

Please sign in to comment.