.. sphinx-paramlinks-sphinx-autoapi-compat documentation master file, created by
   sphinx-quickstart on Fri Sep 20 23:21:42 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

sphinx-paramlinks-sphinx-autoapi-compat
=======================================

**Source repo:**
`demo-sphinx-paramlinks-sphinx-autoapi-compat <https://github.com/smheidrich/demo-sphinx-paramlinks-sphinx-autoapi-compat>`_

In these docs, you'll find demonstrations showing that linking to a parameter
from within the same docstring in which it appears without qualifying it with
its function name using sphinx-paramlinks...

- ... `works fine <works.html>`_ for autodoc-generated docs.
- ... `doesn't work <autoapi/doesntwork/index.html>`_ for API docs generated by
  sphinx-autoapi.


.. toctree::
   :maxdepth: 1
   :caption: Contents:
   :hidden:

   works