Link back to main repo on each page in Documenter.jl

[sloede]

I am sure this has been asked before, but I was not able to find it here or in the Documenter issues:

Is there a way to include a link back to the main repository on each page of Documenter.jl? I know that there’s the Edit on GitHub link but that always takes me to the documentation source, requiring at least one additional click to get to the main repo page and sometimes, e.g., here or here it will not help at all, since the documentation repo is separate from the code repo.

It’s seems like such a small thing, but I constantly run into this issue when browsing and evaluating different packages, and thus I was wondering if I am the only one who misses such a functionality. But maybe there is a reasonable explanation why such a link is not included in Documenter?

[mortenpi]

There isn’t at the moment, but I have a WIP PR for just that. Unfortunately, it ended up being a non-trivial amount of refactoring to get it work right, so I quite haven’t had the time to wrap it up yet.

[tbeason]

Agreed.

Plea to package developers regarding documentation!

Very serious topic ahead: Please please please can package developers put a link BACK to the source repo inside your documentation! Without it, the documentation becomes a trap. Randomly selected example: StatsBase.jl Documentation · StatsBase.jl It is becoming more common now that Google is taking me to documentation pages rather than the Github repo. I frequently flip back and forth between code and documentation, but this process is beyond cumbersome if the documentation contains no easily…

[sylvaticus]

I agree. As a package user and landing to a new package documentstion page, one of the most frequent things I want to do is to go to the main github package page.
As a package developer, what I did is to manually add a link to it on top of my main documentation home page.

[sloede]

@sylvaticus

As a package developer , what I did is to manually add a link to it on top of my main documentation home page.

Haha, same here!

@mortenpi

There isn’t at the moment, but I have a WIP PR for just that. Unfortunately, it ended up being a non-trivial amount of refactoring to get it work right, so I quite haven’t had the time to wrap it up yet.

Wow, I have completely missed that, sorry. Is there anything the community can help to get this PR finished? Not that I claim knowing enough about Documenter’s internals to be of any useful assistance, but maybe there’s something else I can do?

[mortenpi]

@sloede

@mortenpi

There isn’t at the moment, but I have a WIP PR for just that. Unfortunately, it ended up being a non-trivial amount of refactoring to get it work right, so I quite haven’t had the time to wrap it up yet.

Wow, I have completely missed that, sorry. Is there anything the community can help to get this PR finished? Not that I claim knowing enough about Documenter’s internals to be of any useful assistance, but maybe there’s something else I can do?

Primarily it just needs to be brought up to speed with the updates on master. Broadly, the PR contains two things: (1) implementation of the link (HTML, CSS), and (2) a refactoring of the repo keyword of makedocs, so that we would have a good and reliable way of actually determining the URL to the repo. My plan is to split (2) into a separate PR, since that’s the messy bit (and, possibly, to revisit the design decision I made when I started the PR) — if someone wants to beat me to it, you are more than welcome to do so

[sloede]

Thanks for the overview. I had a look at the PR to see how hard it would be to factor out (2), but it seems that any meaningful contribution from my side at this point exceeds my time budget :-/, mostly since essentially everything is new for me…