Skip to content

Commit 263cb93

Browse files
committed
DOC: Update existing links to theory
1 parent c420d98 commit 263cb93

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

doc/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
'sphinx.ext.intersphinx',
4242
'sphinx.ext.doctest',
4343
'sphinxcontrib.bibtex',
44+
'sphinx.ext.extlinks',
4445
'matplotlib.sphinxext.plot_directive',
4546
'nbsphinx',
4647
]
@@ -77,6 +78,9 @@
7778
'matplotlib': ('https://matplotlib.org/', None),
7879
}
7980

81+
extlinks = {'sfs': ('https://sfs.readthedocs.io/en/3.2/%s',
82+
'https://sfs.rtfd.io/')}
83+
8084
plot_include_source = True
8185
plot_html_show_source_link = False
8286
plot_html_show_formats = False

sfs/fd/nfchoa.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def plane_2d(omega, x0, r0, n=[0, 1, 0], *, max_order=None, c=None):
7474
\frac{\i^{-m}}{\Hankel{2}{m}{\wc r_0}}
7575
\e{\i m (\phi_0 - \phi_\text{pw})}
7676
77-
See http://sfstoolbox.org/#equation-D.nfchoa.pw.2D.
77+
See :sfs:`d_nfchoa/#equation-fd-nfchoa-plane-2d`
7878
7979
Examples
8080
--------
@@ -140,7 +140,7 @@ def point_25d(omega, x0, r0, xs, *, max_order=None, c=None):
140140
\frac{\hankel{2}{|m|}{\wc r}}{\hankel{2}{|m|}{\wc r_0}}
141141
\e{\i m (\phi_0 - \phi)}
142142
143-
See http://sfstoolbox.org/#equation-D.nfchoa.ps.2.5D.
143+
See :sfs:`d_nfchoa/#equation-fd-nfchoa-point-25d`
144144
145145
Examples
146146
--------
@@ -208,7 +208,7 @@ def plane_25d(omega, x0, r0, n=[0, 1, 0], *, max_order=None, c=None):
208208
\frac{\i^{-|m|}}{\wc \hankel{2}{|m|}{\wc r_0}}
209209
\e{\i m (\phi_0 - \phi_\text{pw})}
210210
211-
See http://sfstoolbox.org/#equation-D.nfchoa.pw.2.5D.
211+
See :sfs:`d_nfchoa/#equation-fd-nfchoa-plane-25d`
212212
213213
Examples
214214
--------

sfs/td/wfs.py

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,7 @@ def plane_25d(x0, n0, n=[0, 1, 0], xref=[0, 0, 0], c=None):
9696
9797
with wfs(2.5D) prefilter h(t), which is not implemented yet.
9898
99-
References
100-
----------
101-
See http://sfstoolbox.org/en/latest/#equation-d.wfs.pw.2.5D
99+
See :sfs:`d_wfs/#equation-td-wfs-plane-25d`
102100
103101
Examples
104102
--------
@@ -173,9 +171,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
173171
174172
with wfs(2.5D) prefilter h(t), which is not implemented yet.
175173
176-
References
177-
----------
178-
See http://sfstoolbox.org/en/latest/#equation-d.wfs.ps.2.5D
174+
See :sfs:`d_wfs/#equation-td-wfs-point-25d`
179175
180176
Examples
181177
--------
@@ -257,9 +253,7 @@ def focused_25d(x0, n0, xs, ns, xref=[0, 0, 0], c=None):
257253
258254
with wfs(2.5D) prefilter h(t), which is not implemented yet.
259255
260-
References
261-
----------
262-
See http://sfstoolbox.org/en/latest/#equation-d.wfs.fs.2.5D
256+
See :sfs:`d_wfs/#equation-td-wfs-focused-25d`
263257
264258
Examples
265259
--------

0 commit comments

Comments
 (0)