Skip to content

The deco role does not support the tilde modified domain reference #13528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dagardner-nv opened this issue May 6, 2025 · 1 comment · Fixed by #13545
Closed

The deco role does not support the tilde modified domain reference #13528

dagardner-nv opened this issue May 6, 2025 · 1 comment · Fixed by #13545
Labels
domains:py easy issue that can be solved by beginners good first issue type:bug

Comments

@dagardner-nv
Copy link

Describe the bug

When using the :py:deco: role the ~ prefix doesn't shorten the title to the last component, and leaves the tilde character in the rendered html output.

ref:
https://www.sphinx-doc.org/en/master/usage/referencing.html#xref-modifiers
https://www.sphinx-doc.org/en/master/usage/domains/python.html#target-specification

How to Reproduce

test.rst:

Example
=======

 * deco role with tilde :py:deco:`~aiq.cli.register_workflow.register_embedder_client`
 * deco role without tilde :py:deco:`aiq.cli.register_workflow.register_embedder_client`
 * func role :py:func:`~aiq.cli.register_workflow.register_embedder_client`

Environment Information

Platform:              linux; (Linux-6.1.0-32-amd64-x86_64-with-glibc2.36)
Python version:        3.12.0 (main, Oct  3 2023, 01:27:23) [Clang 17.0.1 ])
Python implementation: CPython
Sphinx version:        8.2.3
Docutils version:      0.21.2
Jinja2 version:        3.1.6
Pygments version:      2.19.1

Sphinx extensions

extensions = [
    'autoapi.extension',
    'IPython.sphinxext.ipython_console_highlighting',
    'IPython.sphinxext.ipython_directive',
    'myst_parser',
    'nbsphinx',
    'sphinx_copybutton',
    'sphinx.ext.doctest',
    'sphinx.ext.graphviz',
    'sphinx.ext.intersphinx',
    "sphinxmermaid"
]

Additional context

No response

dagardner-nv added a commit to dagardner-nv/AIQtoolkit that referenced this issue May 7, 2025
@AA-Turner
Copy link
Member

PR welcome!

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domains:py easy issue that can be solved by beginners good first issue type:bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants