Skip to content

Commit dfe4398

Browse files
committed
- repair c3256d7 in that we also
need to use :class: to find class initialization parameters. Bump version to 0.3.4.
1 parent c3256d7 commit dfe4398

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,11 @@ Features
4343
:paramref:`.EnvironmentContext.configure.transactional_ddl`
4444

4545
The directive makes use of the existing Python role to do the method/function
46-
lookup, searching first the ``:meth:`` and then the ``:func:`` role; then
47-
the parameter name is applied separately to produce the final reference link.
48-
(new in 0.3.3, search for ``:meth:`` / ``:func:`` individually rather than
49-
using ``:obj:`` which catches lots of things that don't have parameters)
46+
lookup, searching first the ``:meth:``, then the ``:class:``, and then the
47+
``:func:`` role; then the parameter name is applied separately to produce the
48+
final reference link. (new in 0.3.4, search for ``:meth:`` / ``:func:`` /
49+
``:class:`` individually rather than using ``:obj:`` which catches lots of
50+
things that don't have parameters)
5051

5152
* The paramlinks are also added to the master index as well as the list
5253
of domain objects, which allows them to be searchable through the

sphinx_paramlinks/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
__version__ = '0.3.3'
1+
__version__ = '0.3.4'
22

33
from .sphinx_paramlinks import setup # noqa

sphinx_paramlinks/sphinx_paramlinks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ def lookup_params(app, env, node, contnode):
178178
# along with the classname/methodname/funcname minus the parameter
179179
# part.
180180

181-
for search in ["meth", "func"]:
181+
for search in ["meth", "class", "func"]:
182182
newnode = domain.resolve_xref(
183183
env, refdoc, app.builder,
184184
search, resolve_target, node, contnode)

0 commit comments

Comments
 (0)