Content-Length: 304434 | pFad | http://github.com/sphinx-doc/sphinx/issues/11417

09 `versionadded`, `versionchanged`, `deprecated` version field doesn't accept markup · Issue #11417 · sphinx-doc/sphinx · GitHub
Skip to content

versionadded, versionchanged, deprecated version field doesn't accept markup #11417

Open
@iguessthislldo

Description

@iguessthislldo

Describe the bug

I'd like to use the version in the versionadded, versionchanged, and deprecated directives to link to the release notes for that version so a user could see relevant changes that might have occurred in that release. That doesn't seem like it's possible though because the markup for the ref role looks like it gets passed through as is. I can reference it in the rest of the text, but then it seems like I have to state the version twice.

How to Reproduce

Here's an example where I tried a couple different things:

.. _v1_0_0:

v1.0.0
------

.. versionadded:: :ref:`v1_0_0`
  Added ``foo`` parameter in :ref:`v1_0_0`

.. versionchanged::
  :ref:`v1_0_0` ``foo`` parameter is now an ``int``.

.. deprecated:: :rfc:`1`
  Other roles don't seem to work either

image

Environment Information

Platform:              linux; (Linux-5.19.0-41-generic-x86_64-with-glibc2.35)
Python version:        3.10.6 (main, Mar 10 2023, 10:55:28) [GCC 11.3.0])
Python implementation: CPython
Sphinx version:        6.2.1
Docutils version:      0.19
Jinja2 version:        3.1.2
Pygments version:      2.15.1

Sphinx extensions

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions









      ApplySandwichStrip

      pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


      --- a PPN by Garber Painting Akron. With Image Size Reduction included!

      Fetched URL: http://github.com/sphinx-doc/sphinx/issues/11417

      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy