Skip to content

Document the requirement to push releases #2109

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 3 commits into from
Apr 13, 2025
Merged

Document the requirement to push releases #2109

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb9498d
Document the requirement to push releases
axelson Apr 6, 2025
f07fa16
Update lib/mix/tasks/docs.ex
axelson Apr 8, 2025
e3ff122
Give the source_ref/source_url its own section
axelson Apr 12, 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
8 changes: 8 additions & 0 deletions lib/mix/tasks/docs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ defmodule Mix.Tasks.Docs do
]
end

> #### Tip {: .info}
>
> If you set `:source_url` to a GitHub/GitLab/BitBucket repo then whenever you
> publish a release you should publish the release to the repo (which will
> push a tag). If the release exists in the repo then ex_doc will generate
> links to the specific version of the code that the user is currently
> browsing.

ExDoc also allows configuration specific to the documentation to
be set. The following options should be put under the `:docs` key
in your project's main configuration. The `:docs` options should
Expand Down