Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for umbrella projects via CLI #2089

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

robertoaloi
Copy link
Contributor

@robertoaloi robertoaloi commented Feb 5, 2025

While the ExDoc API already supports umbrella projects, the functionality is not exposed through the ex_doc CLI, 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 ebin directories when invoking ex_doc. If multiple ebin directories are specified and no custom groups_per_modules option is specified, we automatically group modules by application, which seems to be a sensible default.

Fixes #2071

@josevalim
Copy link
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!

Copy link

github-actions bot commented Feb 5, 2025

@robertoaloi
Copy link
Contributor Author

Added some tests to verify all possible combinations. Let me know if that's what you had in mind as well.

@josevalim josevalim merged commit 2986c5d into elixir-lang:main Feb 6, 2025
5 checks passed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Native support for "umbrella" Erlang projects
2 participants