Question

我没有看到上面的答案，所以这是我的问题：

我有一套项目。它们表示为嵌套的Git子模块，如下所示：

MAIN-PROJECT
    LIBRARY-1
        LIBRARY-2
            ETC.

每个子模块都有一个README.md文件和CHANGELOG.md文件（标准GitHub模型）：

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

我想要做的是使用“Root”README作为转储中的主页，但仍然呈现内部README，因为每个都有很好的信息。

我不想单独构建每个Doxygen转储。我希望有一个单一的整体转储，从“Root”开始。这是因为我想要类和诸如此类的链接。

有办法做到这一点吗？我尝试明确指定“Root”README，但看起来你只能提供文件名，而不是路径。这意味着每个自述文件都被考虑用于帖子，获胜的是“最深的”。

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

试图将多个README.md文件合并到一个Doxygen转储中

1 个答案: