Support for umbrella projects via CLI #2089
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Member
| Thank you! I also think we need one test in ex_doc/config_test.exs for the group_for_modules config and we should be good to go! |
| 📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/13174525853/artifacts/2546035512 |
Contributor Author
| Added some tests to verify all possible combinations. Let me know if that's what you had in mind as well. |
Member
| 💚 💙 💜 💛 ❤️ |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
While the
ExDocAPI already supports umbrella projects, the functionality is not exposed through theex_docCLI, making it hard to create sites for projects that include more than one application.Here we propose a simple change, allowing users to specify multiple
ebindirectories when invokingex_doc. If multipleebindirectories are specified and no customgroups_per_modulesoption is specified, we automatically group modules by application, which seems to be a sensible default.Fixes #2071