diff --git a/doc/source/development/debugging_extensions.rst b/doc/source/development/debugging_extensions.rst index cfed8dfbc5a85..32cb8f4c4d8cd 100644 --- a/doc/source/development/debugging_extensions.rst +++ b/doc/source/development/debugging_extensions.rst @@ -119,3 +119,13 @@ Note that code execution under valgrind will take much longer than usual. While .. note:: For best results, you should run use a Python installation configured with Valgrind support (--with-valgrind) + + +Easier code navigation +====================== + +Generating a ``compile_commands.json`` file may make it easier to navigate the C extensions, as this allows your code editor to list references, jump to definitions, etc... To make this work with setuptools you can use `Bear `_. + +.. code-block:: sh + + bear -- python setup.py build_ext --inplace -j4 --with-debugging-symbols