david_ex

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 Switch mode

wojtekmach

wojtekmach

Hex Core Team

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).

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement