Skip to content

Fix docs: Move source_url to project #2172

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 22, 2025
Merged

Fix docs: Move source_url to project #2172

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc8ba89
Fix docs: Move `source_url` to `project`
ftes Nov 21, 2025
302b36b
Document source_url and update project example
josevalim Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions lib/mix/tasks/docs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,9 @@ defmodule Mix.Tasks.Docs do

* `:source_beam` - Path to the beam directory; default: mix's compile path.

* `:source_url` - The source URL fallback if `:source_url` is not given at the project
configuration. See the following sections.

* `:source_ref` - The branch/commit/tag used for source link inference;
default: "main".

Expand Down Expand Up @@ -228,7 +231,7 @@ defmodule Mix.Tasks.Docs do
both of them will allow ExDoc to link to specific version of the code for a function or module
that matches the version of the docs. So if the docs have been generated for version 1.0.5 then
clicking on the source link in the docs will take the browser to the source code for the 1.0.5
version of the code instead of only the primary ref (e.g. `main`).
version of the code instead of only the primary ref (for example, `main`).

A example setup looks like:

Expand All @@ -237,16 +240,16 @@ defmodule Mix.Tasks.Docs do
[
...
version: @version,
docs: docs(),
...
source_url: "https://github.com/USER/PROJECT",
docs: &docs/0
]
end

def docs do
...
source_ref: "v#{@version}",
source_url: @source_url,
...
[
...
source_ref: "v#{@version}"
]
end

If you use `source_ref: "v#{@version}"` then when publishing a new version of your package you
Expand Down