Way to generate deps + project docs into /doc dir?

Hey, I’ve just discovered ‘mix docs’ and I am curious if there is a way to generate dependencies’ docs locally too? What I want to achieve is to open doc/index.html and get access to documentation from my project and all deps it’s using.

According to the official docs, you can use the :deps flag:

https://hexdocs.pm/ex_doc/Mix.Tasks.Docs.html

  • :deps - A keyword list application names and their documentation URL. ExDoc will by default include all dependencies and assume they are hosted on HexDocs. This can be overridden by your own values. Example: [plug: "https://myserver/plug/"]

No, thats for links in the generated documentation to remote types or functions from those dependencies.

None that I’m aware of. But perhaps you can make use of mix hex.docs fetch $package and mix hex.docs offline $package?

3 Likes

Hmm, that’s not exactly what I wanted, but it will do the job. Thanks a lot!