Make sure pipeline works with submodule
To automatically include the auto generated documentation, the original code is included as a submodule.
This means that a few changes have to be taken into account:
-
The CI must clone the submodule as well -
It needs acces to the original repo (this should already be the case, due to the permission model any user that triggers the pipeline and has access to the submodule's repo causes the runner to also have access) -
The minimal build with auto docs must complete successfully, this might be a problem due to MPI. So eithe rmake sure the build environment can build the library, or somehow change CMake to only build the docs. -
Similarly, python3 with breathe and recommonmark as well as doxygen must be available.
The current proposal is done in the include_autodocs
branch.
When cloning yourself, make sure to add --recursive
to the command to include the submodule directly.