How to escape double colon in Python Sphinx

Question

Let's imagine we have the following FireBreath call:

.. method:: Foo::Bar(std::vector)

As you may already understood the double colons interfere with the official Sphinx syntax and although it does show up, there is no link, associated with this method (i.e. it couldn't be accessed with :method: reference for example).

Adding escape symbol (\) didn't really help and although it still shows up, the link doesn't work. Is there any workaround or this is a unavoidable limitation of Sphinx platform?

Answer 1

You should be able to use the C++ domain in Sphinx. Like this:

.. cpp:function:: Foo::Bar(std::vector)

A cross-reference to this method would look like this:

:cpp:func:`Foo::Bar`