Make exdocs settings a bit more similar between different packages (#168)

* Add source_url_pattern to be able to use the "link to source" button
* Add README.md as an "extra" where it wasn't already
* Add a `main` setting. They all have a very obvious main module. Set
  that as `main`, so a user is shown this immediately instead of a list
  of usually only this module.
This commit is contained in:
Patrik Stenmark 2023-04-30 20:10:03 +02:00 committed by GitHub
parent 1230271580
commit ddf0706bf1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 50 additions and 9 deletions

View File

@ -13,7 +13,13 @@ defmodule OpentelemetryDataloader.MixProject do
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),
source_url: source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_dataloader" "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_dataloader",
docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_dataloader/%{path}#L%{line}",
main: "OpentelemetryDataloader",
extras: ["README.md"]
]
] ]
end end

View File

@ -13,7 +13,13 @@ defmodule OpentelemetryEcto.MixProject do
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),
source_url: source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_ecto" "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_ecto",
docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_ecto/%{path}#L%{line}",
main: "OpentelemetryEcto",
extras: ["README.md"]
]
] ]
end end

View File

@ -12,7 +12,13 @@ defmodule OpentelemetryFinch.MixProject do
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),
source_url: source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_finch" "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_finch",
docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_finch/%{path}#L%{line}",
main: "OpentelemetryFinch",
extras: ["README.md"]
]
] ]
end end

View File

@ -12,7 +12,13 @@ defmodule OpentelemetryNebulex.MixProject do
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),
source_url: source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_nebulex" "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_nebulex",
docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_nebulex/%{path}#L%{line}",
main: "OpentelemetryNebulex",
extras: ["README.md"]
]
] ]
end end

View File

@ -9,6 +9,8 @@ defmodule OpentelemetryOban.MixProject do
start_permanent: Mix.env() == :prod, start_permanent: Mix.env() == :prod,
deps: deps(), deps: deps(),
docs: [ docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_oban/%{path}#L%{line}",
main: "OpentelemetryOban", main: "OpentelemetryOban",
extras: ["README.md"] extras: ["README.md"]
], ],
@ -24,7 +26,9 @@ defmodule OpentelemetryOban.MixProject do
"OpenTelemetry.io" => "https://opentelemetry.io" "OpenTelemetry.io" => "https://opentelemetry.io"
}, },
files: ~w(lib .formatter.exs mix.exs README* LICENSE* CHANGELOG*) files: ~w(lib .formatter.exs mix.exs README* LICENSE* CHANGELOG*)
] ],
source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_oban"
] ]
end end

View File

@ -17,6 +17,8 @@ defmodule OpentelemetryPhoenix.MixProject do
name: "Opentelemetry Phoenix", name: "Opentelemetry Phoenix",
docs: [ docs: [
main: "OpentelemetryPhoenix", main: "OpentelemetryPhoenix",
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_phoenix/%{path}#L%{line}",
extras: ["README.md"] extras: ["README.md"]
], ],
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),

View File

@ -12,7 +12,13 @@ defmodule OpentelemetryRedix.MixProject do
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),
source_url: source_url:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_redix" "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_redix",
docs: [
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_redix/%{path}#L%{line}",
main: "OpentelemetryRedix",
extras: ["README.md"]
]
] ]
end end

View File

@ -11,7 +11,10 @@ defmodule OpentelemetryReq.MixProject do
deps: deps(), deps: deps(),
name: "Opentelemetry Req", name: "Opentelemetry Req",
docs: [ docs: [
main: "OpentelemetryReq" source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_req/%{path}#L%{line}",
main: "OpentelemetryReq",
extras: ["README.md"]
], ],
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
package: package(), package: package(),

View File

@ -5,7 +5,7 @@ Tesla middleware that creates OpenTelemetry spans and injects tracing headers in
## Installation ## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed The package is [available in Hex](https://hex.pm/packages/opentelemetry_tesla) and can be installed
by adding `opentelemetry_tesla` to your list of dependencies in `mix.exs`: by adding `opentelemetry_tesla` to your list of dependencies in `mix.exs`:
```elixir ```elixir

View File

@ -17,7 +17,9 @@ defmodule OpentelemetryTesla.MixProject do
defp docs() do defp docs() do
[ [
main: "readme", main: "readme",
extras: ["README.md"] extras: ["README.md"],
source_url_pattern:
"https://github.com/open-telemetry/opentelemetry-erlang-contrib/blob/main/instrumentation/opentelemetry_tesla/%{path}#L%{line}"
] ]
end end