Skip to content

Commit 64ad6c0

Browse files
committed
link method in example to autodoc
1 parent d30248e commit 64ad6c0

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

doc/conf.py

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,25 @@
4242
# autodoc conf
4343
autoclass_content = "both"
4444

45+
# Example configuration for intersphinx: refer to the Python standard library.
46+
intersphinx_mapping = {
47+
"numpy": ("https://numpy.org/doc/stable/", None),
48+
"python": ("https://docs.python.org/3/", None),
49+
"matplotlib": ("https://matplotlib.org/", None),
50+
}
51+
52+
4553
sphinx_gallery_conf = {
4654
"examples_dirs": "../examples", # path to your example scripts
4755
"gallery_dirs": "python_module",
4856
"capture_repr": ("_repr_html_",),
4957
"backreferences_dir": "gen_modules/backreferences",
5058
"doc_module": ("py_eddy_tracker",),
59+
"reference_url": {
60+
"py_eddy_tracker": None,
61+
"matplotlib": "https://matplotlib.org/",
62+
"numpy": "https://docs.scipy.org/doc/numpy/",
63+
},
5164
"line_numbers": False,
5265
"filename_pattern": "/pet",
5366
"binder": {
@@ -323,11 +336,3 @@
323336

324337
# If true, do not generate a @detailmenu in the "Top" node's menu.
325338
# texinfo_no_detailmenu = False
326-
327-
328-
# Example configuration for intersphinx: refer to the Python standard library.
329-
intersphinx_mapping = {
330-
"numpy": ("https://numpy.org/doc/stable/", None),
331-
"python": ("https://docs.python.org/3/", None),
332-
"matplotlib": ("https://matplotlib.org/", None),
333-
}

0 commit comments

Comments
 (0)