How do I use breathe_projects_source?

[red8888]

I see examples like this: breathe_projects_source = {"pyne": '../',}
And like this: breathe_projects_source = {"auto" : ( "../examples/specific", ["auto_function.h", "auto_class.h"] )}
Pretty sure the latter is correct because I get a KeyError: 'auto' otherwise.

I'm using C# and I just want to recurse through all files in my project.

in conf.py I have this:

# Just look for all files
breathe_projects_source = {"auto" : ( "../", ["**"] )}

In an rst I have this:

Working Example
---------------

.. autodoxygenindex::
   :project: auto

When I build the docs I get no error but its blank under Working Example.

I also tried this: breathe_projects_source = {"auto" : ( "/full/path/app", ["**"] )}
I also tried this: breathe_projects_source = {"auto" : ( "/full/path/app", ["specificfile.cs"] )}

I'm getting no errors or warnings so I don't know what is wrong.

[red8888]

I found out breathe only works with c++.

Found this thread and used this guys branch to try to get it working with a csharp domain: #550

pip install git+https://github.com/rogerbarton/sphinx-csharp.git

Doing that doxygenindex does work but autodoxygenindex still does not. Is there something about autodoxygenindex that makes it only work with c++?

[vermeeren]

@red8888 C# support is merged and released in Breathe, but yes you do need to use third-party Sphinx C# domain. Last time I checked this it was https://github.com/rogerbarton/sphinx-csharp but I don't know what current version is. @rogerbarton contributed literally everything C# to Breathe and de-facto maintains it. Currently doc is missing though for C#.

As for the auto* directives I really suggest you setup Doxygen manually and use the non-auto variants, it's much easier to customise that and make it work especially in non-standard setup like C#.

[rogerbarton]

I've never heard of the auto* directive, so I don't know if it will work with the C# domain.

I'm aware that the docs for the C# domain are missing, but I feel like this is a very specific use case without many peopling using it. So I find it hard to justify adding documentation. But, I've updated the readme a bit just now.

To use the C# domain you really have to look at the example where I am using it. Alternatively the minimal, but working, test project in my repo might be helpful.