elixir-lang
Broken links for dependencies belonging to organizations
I noticed that ex_doc generates wrong links for private packages belonging to organizations.
For example, if I have package linking to module Foo, which belongs to the package :foo, and :foo belongs to the organization my-org the automatic link will be hexdocs.pm/foo/Foo instead of my-org.hexdocs.pm/foo/Foo. Naturally, this link will be broken.
I traced the link generation to here: https://github.com/elixir-lang/ex_doc/blob/d8146c397fde7df2a09497b379a801519f3c2e66/lib/mix/tasks/docs.ex#L534-L539
As you can see, it doesn't consider whether the package belongs to an organization or not.
I tried to fix it, but didn't find any API to find to which organization a package belongs to.
@wojtekmach suggested usings the :deps option for ex_doc to point the correct dependency documentation urls. While this works, it's a big burden to maintain, and I think this could be solved in a simple and more correct way at ex_doc.
@garazdawi this may be related to the conversation we had earlier this week. If we could store in the application the "documentation_url", then it could be used here too?
The configuration would have to live somewhere like that, so the app file seems like a reasonable place. I discuss it with the team next week and see what they say. If nothing else we can use an application parameter as the place to put it for this and errors.
If this can't be fixed short term, I'd love to have some decent workaround. I know I can use the :deps option to set the address of package docs.
But I don't know any way I can read my deps, and iterate on the ones that belong to organizations so that I can provide the correct address. I wouldn't like to hardcode the list of organization dependencies. The deps() function isn't enough as it doesn't include dependencies of dependencies.
I appreciate suggestions on how to achieve that.
You may be able to read the mix.lock and get all relevant information there. I guess we could also change ExDoc to look at the dependencies options and figure out private Hex repos. We could also allow :deps to be a function, so it is all programmatically.
store in the application the "documentation_url"
I believe it would be great to have it alongside source_url and homepage_url so maybe projects like ElixirLS could also make use of it to provide link highlights to private docs.
