bug: relative_crossrefs not rendered in summary table. #331

Activity

1. damskii9992

   assigned

   pawamoy

   on Jun 16, 2026
2. damskii9992

   added

   unconfirmedThis bug was not reproduced yetThis bug was not reproduced yet

   on Jun 16, 2026
3. damskii9992

   changed the title [-]bug:[/-] [+]bug: `relative_crossrefs` not rendered in `summary` table.[/+] on Jun 16, 2026
4. pawamoy commented on Jun 16, 2026

   

   pawamoy

   on Jun 16, 2026

   Member

   More actions

   Thanks for the report @damskii9992.

   git clone https://github.com/easyscience/imaging-lib/tree/documentation

   That's not a valid command.

   The table

   What table? Please point me at the docstrings that illustrate the issue, or provide an actual minimal repro 🙂
5. damskii9992 commented on Jun 18, 2026

   

   damskii9992

   on Jun 18, 2026

   Last edited by damskii9992

   Author

   More actions

   Apologies, I should've tested the commands first. 😢
   This should work:

   git clone -b docs-example --single-branch https://github.com/easyscience/imaging-lib.git
   cd imaging-lib
   pixi install
   pixi run docs-serve

   And then open the documentation in your favourite browser. The final output should list where the documentation got served, for me it was: http://127.0.0.1:8000/imaging-lib/

   Then, navigate to API Reference and to Measurement and scroll down to the summary table, i.e. the table of method and attributes summaries provided when using summary: true in the mkdocs.yml file options. There you should see the bug. Interestingly enough the relative crossrefs works for imported inventories.

   I can also try to reproduce a minimal example using the syntax from your documentation:

   In the python file package/module.py

   """Module docstring."""
   
   class ThisClass:
       """Class docstring."""
   
       def method(self):
           """Method docstring with relative crossref to parent [class][..]"""

   And in mkdocs.yml:

   plugins:
   - mkdocstrings:
       handlers:
         python:
           options:
             summary: true
             relative_crossrefs: true

   I have not tested it, but the above minimal example should also show the bug.
6. pawamoy

   added

   bugSomething isn't workingSomething isn't working

   and removed

   unconfirmedThis bug was not reproduced yetThis bug was not reproduced yet

   on Jun 18, 2026
7. pawamoy

   added a commit that references this issue on Jun 19, 2026

   fix: Allow relative cross-references to work in summaries

   ...

   abe2888
8. pawamoy commented on Jun 19, 2026

   

   pawamoy

   on Jun 19, 2026

   Member

   More actions

   Thanks! Fixed in abe2888 🙂

   🎉React with 🎉1Reacted by Christian Dam Vedel
9. pawamoy

   closed this as completedon Jun 19, 2026