Readthedocs C++11 API missing Open variant

ornladios / ADIOS2

Next generation of ADIOS developed in the Exascale Computing Program

https://adios2.readthedocs.io/en/latest/index.html

Apache License 2.0

268 stars 125 forks source link

Readthedocs C++11 API missing Open variant #3307

Open pnorbert opened 2 years ago

pnorbert commented 2 years ago

The C++11 API doc at https://adios2.readthedocs.io/en/latest/api_full/api_full.html#c-11-bindings only lists the non-mpi Open() function of the IO class. The variant to pass a communicator is missing. Why?

eisenhauer commented 2 years ago

Odd. (It's the ADIOS class, not IO, yes?) But I have no idea why no MPI version. It's in other language bindings...

pnorbert commented 2 years ago

Oh, same for the ADIOS class, the constructors with MPI are also missing, and the same problem for the C API.

williamfgc commented 2 years ago

Might be related to doxygen not parsing inside #if ADIOS2_HAVE_MPI: see here. I don't know how to enable this on breathe, see docs. Maybe using a dummy file inside docs and redirecting the location in :path here is a sensible workaround.