Formatting "template <typename T>" part of C++ declarations

michaeljones avatarmichaeljones created an issue


I understand this is a pretty subjective request, but I would like to be able to specify a C++ function with template parameters like:

.. cpp:function:: template <typename T>

And have it render as:

template <typename T>

Currently it will render as two separate functions in the final output or if you put it on one line then it comes out as one line:

template <typename T> SymmetricAerodynamics::set_kind()

In other documentation tools (eg. doxygen) and generally in C++ code layout the template< typename T> part goes on the line above. I would also be happy to specify it on one line and have Sphinx automatically insert the line break.

If this seems like a reasonable thing to support then I would be happy to try to look into implementing it. My interest is in part driven by my work on the Breathe Sphinx extension which generally deals with C++ and would benefit from this multi-line support in the rendering of desc_signature node.

I realise the impact of this change my be considered to be breaking/changing current behaviour and so cannot be done.

Cheers, Michael

Comments (0)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.