Trying to Incorporate Multiple README.md Files Into A Doxygen Dump

Question

I don't see an answer for this above, so here's my question:

I have a set of projects. They are expressed as nested Git Submodules, like so:

MAIN-PROJECT
    LIBRARY-1
        LIBRARY-2
            ETC.

Each submodule has a README.md file and CHANGELOG.md file (standard GitHub model):

MAIN-PROJECT
    README.md
    CHANGELOG.md
    LIBRARY-1
        README.md
        CHANGELOG.md
        LIBRARY-2
            README.md
            CHANGELOG.md
            ETC.

What I want to do, is use the "Root" README as the mainpage in the dump, but still render the internal READMEs, as each has good information.

I don't want to individually build each Doxygen dump. I want to have a single, monolithic dump that starts in the "Root." This is because I want the classes and whatnot to link.

Is there a way to do this? I tried specifying the "Root" README explicitly, but it looks like you can only give the filename, not the path. This means that EVERY README is considered for the post, and the one that wins is the "deepest" one.

Answer 1

To be able to use multiple 'README.md' file there are a few things to take in consideration:

• specify the major README.md with a relative path when using USE_MDFILE_AS_MAINPAGE.
• alternatively use \mainpage in the master 'README.md'
• use \page in the other 'README.md' so one can distinguish the different files.

Note also the possibilities of \subpage and \ref to refer to other pages