search

coryodaniel / k8s

Kubernetes API Client for Elixir
MIT License
317 stars 46 forks source link

Source links in the documentation are incorrect #172

Closed icehaunter closed 2 years ago

icehaunter commented 2 years ago

On https://hexdocs.pm/k8s/ all the links to function/module source code look like they've been incorrectly generated, e.g. in the https://hexdocs.pm/k8s/K8s.Client.html the link to the module reads https://github.com/coryodaniel/k8s/blob/1.1.5//Users/mruoss/src/ufg/community/k8s/lib/k8s/client.ex#L1 when it should https://github.com/coryodaniel/k8s/blob/1.1.5/k8s/lib/k8s/client.ex#L1

I believe this is a generator misconfiguration, as these look like absolute paths on the @mruoss machine :)

mruoss commented 2 years ago

Yes! I have noticed some time ago and was like I need to fix this ASAP. But I have been a bit short on P so I forgot. If anybody knows what's wrong, please let me know, otherwise I am gonna investigate ASAP!

icehaunter commented 2 years ago

Checked out code and ran mix deps.get && mix docs -- it generated correct links. No idea how they could've been generated incorrectly in the first place, I cannot find a relevant setting at all.

My machine is on Arch Linux tho, not on MacOS (judging by the path format)

mruoss commented 2 years ago

Tried it again on my MacOS - no luck. So I used my Linux machine to republish the docs. Should be fixed now.

I'd still be intersted to know why that did not work on MacOS but don't have the time to investigate further right now...