File tree Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -412,3 +412,27 @@ the title of a page.
412412 Stub pages are generated also based on these directives.
413413
414414.. _`escape filter` : https://jinja.palletsprojects.com/en/3.0.x/templates/#jinja-filters.escape
415+
416+ Autolink role
417+ -------------
418+
419+ .. rst :role :: autolink
420+
421+ The ``:autolink: `` role functions as ``:py:obj: `` when the referenced *name *
422+ can be resolved to a Python object, and otherwise it becomes simple emphasis.
423+
424+ There are some known design flaws.
425+ For example, in the case of multiple objects having the same name,
426+ :rst:role: `!autolink ` could resolve to the wrong object.
427+ It will fail silently if the referenced object is not found,
428+ for example due to a spelling mistake or renaming.
429+ This is sometimes unwanted behaviour.
430+
431+ Some users choose to configure their :confval: `default_role ` to ``autolink ``
432+ for 'smart' referencing using the default interpreted text role (```content` ``).
433+
434+ .. seealso ::
435+
436+ :rst:role: `any `
437+
438+ :rst:role: `py:obj `
You can’t perform that action at this time.
0 commit comments