autodoxygenindex Directive Example

Working Example

This should work:

.. autodoxygenindex::
   :project: auto

With the following config value:

breathe_projects_source = {
    "auto" : ( "../examples/specific", ["auto_function.h", "auto_class.h"] )
}

It produces this output:

class AutoClassTest

#include <auto_class.h>

class outside of namespace

Private Functions

inline void member()

non-namespaced class function

inline void anotherMember()

non-namespaced class other function

file auto_class.h

file auto_function.h

Functions

void autoFunction()

non-namespaced class function

void anotherAutoFunction()

non-namespaced class other function

dir /home/docs/checkouts/readthedocs.org/user_builds/breathe/checkouts/latest/examples

dir /home/docs/checkouts/readthedocs.org/user_builds/breathe/checkouts/latest/examples/specific