Support including multiple files called `README.md`

[p2]

This is related to #565 and #556 with one difference: all files I'd like to include are named README.md.

To be compatible with the Swift Package Manager, modules of our framework live in /Sources/Module directories, and each of those directories contains a README file so it displays nicely on GitHub. I have a jazzy configuration that basically replicates this setup using custom_categories, so if I could give the path to the respective README per module (as suggested by #565) that could work for us, but it would need to be the path, not file name.

Alternatively it could work if documentation (and/or abstract) were a little bit smarter. With the following specification, I will end up with exactly one README entry under Other Guides and these warnings in the shell:

documentation: Sources/*/README.md

Found conflicting type declarations with the same name, which may indicate a build issue or a bug in Jazzy: guide README, guide README, guide README, guide README, guide README, guide README, guide README, guide README

If it would derive the module name from the differences in the path, rather than the filename, this could work.

Thanks a lot for jazzy!!

p.s. Project in question: https://github.com/C3-PRO/c3-pro-ios-framework

[istx25]

Hi @p2. Thanks for filing this issue. I don't think this is something we currently have the bandwidth to work on but I'd happily review a PR if you're willing to put something together. Cheers!