search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
306 stars 23 forks source link

Cref role should allow for custom link text #41

Closed johanseland closed 3 years ago

johanseland commented 3 years ago

When writing RST that references into Doxygen/Doxyrest documentation, I sometimes would want to use a custom-link text, instead of the fully qualified C/C++ name. Ideally, it would work similar to the way the :ref: role allows for using a custom link text, e.x.

:cref:`custom link text<my::fully::qualified::name>`.

My main use case for this is that I sometimes list several classes in a sentence, all coming from the same, nested namespace. Since my fully qualified symbol names are so long and without spaces, the "formatted link names" end up ruining the line breaking since there is only room for one name on each line.

vovkos commented 3 years ago

Apologies for the long delay. Doxyrest 2.1.3 supports cref links with custom display text.