sphinx-paramlinks-sphinx-autoapi-compat¶

Source repo: 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 for autodoc-generated docs.

  • … doesn’t work for API docs generated by sphinx-autoapi.

sphinx-paramlinks-sphinx-autoapi-compat

Navigation

Contents:

  • Works fine
  • API Reference

Related Topics

  • Documentation overview
    • Next: Works fine
©2024, SH. | Powered by Sphinx 8.0.2 & Alabaster 1.0.0 | Page source