david_ex
ExDoc: link to docs for Erlang dependency
Per the docs, ExDoc is able to link to Elixir modules found in Hex. I’d link to do the same for hackney but can’t get it to work. How can I e.g. have “Depends on :hackney.” in my docs with a nice link to :hackney? The same works when e.g. replacing :hackney with Jason.
Marked As Solved
wojtekmach
We’re not auto linking to Erlang modules because it’s too easy to get a false positive, imagine:
Options:
* `:file` - name of the file
we don’t want to link to file — OTP 29.0.2 (kernel 11.0.2).
We’re still auto linking to functions though so this will work:
See `:hackney.request/1`.
and will link to hackney — hackney v4.4.5.
For your particular case, I suggest either of these:
Depends on [`:hackney`](https://hexdocs.pm/hackney).
[Depends on `:hackney`](https://hexdocs.pm/hackney).
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Courses that'll move you from confusion to "Aha, now I get it!"
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Producing high quality Elixir screencasts since 2017.
Enabling companies to succeed by building software people love.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"