First use of MrDox: configuration

[Becheler]

Hi people, Amazing job on mrdox ! I'm trying to use it :) I have the following folder structure:

APP [DEV CONTAINER: C++ ...]
├── build
├── docs
├── example
├── mrdox
│   ├── CMakeLists.txt
│   ├── coalescence.cpp
│   ├── config.yaml
│   ├── demography.cpp
│   ├── expressive.cpp
│   ├── geography.cpp
│   └── io.cpp
├── src
├── test
├── CMakeLists.txt

Example of a mrdox/*.cpp file:

#include "quetzal/coalescence.hpp"
int main(){ return 0; }

• All mrdox/*.cpp files compile fine when running cmake with export_compile_commandsset to ON
• I am not sure what the config.yaml should be, especially the source-root value ?
• For now I used the documentation one:

  concurrency: 1      # number of threads to use
  source-root: ../    # source files relative to the mrdox.yml file
  multipage: false    # generate multiple pages
  verbose: true       # print verbose output

[alandefreitas]

Yes. source-root looks correct. For the compilation-database option, it might be the path to you compile_commands.json or the path to your CMakeLists.txt (so that mrdocs runs it for you and gets the compile_commands.json). If you give it a CMakeLists.txt file, then you can also use the cmake option to define arguments for the cmake configuration step.

[alandefreitas]

Here's a more complete example: https://github.com/boostorg/url/blob/develop/doc/mrdocs.yml

It'll also use CMakeLists.txt in source-root if no compilation-database is provided.