Cross referencing vs sphinx

[AntoineD]

Hello,

the project I work for is in the process of converting its documentation from sphinx to mkdocs.
We make use of the very convenient reference target specification and resolution of sphinx.

We have tried this plugin but it is not on par with sphinx's related powerful simplicity and features.

We are considering sponsoring mkdocstring to get access to relative and scoped cross-referencing features, but we wonder how it compares to sphinx features.

Would it be possible to have clarifications on these?

[pawamoy]

The ~ prefix is not supported, but scoped cross-references make it superfluous in most cases. Relative cross-refs (with a . prefix seem to resolve the same way as in Sphinx. One thing I noticed could be improved is that [..render][] will display a link with ..render as title instead of render (dots not stripped). One can always re-specify the title anyway: [render][..render].

If you show me how you use Sphinx cross-refs I can show you equivalent in mkdocstrings/autorefs 🙂