Skip to content
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.

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

Link to repo in navbar #1254

Merged
merged 46 commits into from
Jul 21, 2022
Merged

Link to repo in navbar #1254

merged 46 commits into from
Jul 21, 2022

Conversation

mortenpi
Copy link
Member

@mortenpi mortenpi commented Mar 8, 2020

Adds a way to link to the root of the repository in the navbar. The prominence of the edit link is reduced by having it just as an icon:

repolink

By default, HTMLWriter will try to figure this out based on the remote repository, which can be configured using the repo argument of makedocs:

  • Documenter now exports the Remotes module, which contains types to configure the remote explicitly, e.g.: makedocs(repo = Remotes.GitHub("JuliaDocs", "Documenter.jl")
  • If the repo keyword is not passed, Documenter tries to determine it by looking at the origin remote of the source (as before).
  • The old URL template strings can also be passed, but in that case the repository link will be hidden, as we don't know what part of the URL is the root.

The HTML format type now also takes the repolink keyword which can be used to either override the repository URL determined from repo (by passing a String), or hide the repository link (by passing nothing).

Close #1377

@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Mar 8, 2020
@mortenpi mortenpi added this to the 0.25.0 milestone Mar 8, 2020
@mortenpi mortenpi changed the title Link to repo in navbar WIP: Link to repo in navbar Mar 8, 2020
@mortenpi mortenpi removed this from the 0.26.0 milestone Dec 8, 2020
@tfiers
Copy link

tfiers commented Jan 13, 2022

There is animo for this!

(https://julialang.slack.com/archives/C67TK21LJ/p1640113944190400)

Anything we can do to help?

@mortenpi mortenpi changed the title WIP: Link to repo in navbar Link to repo in navbar Jul 20, 2022
@mortenpi mortenpi merged commit ef4412f into master Jul 21, 2022
@mortenpi mortenpi deleted the mp/repolink branch July 21, 2022 04:35
@gaurav-arya
Copy link

It seems like this change has not been included in the latest release, although it was included in the changelog for v0.27.22? https://github.com/JuliaDocs/Documenter.jl/blob/v0.27.23/src/Writers/HTMLWriter.jl

@fredrikekre
Copy link
Member

It is under the 0.28 release, no?

@sloede
Copy link

sloede commented Oct 16, 2022

Out of curiosity (since I've been watching this PR as well): Is there a (tentative) ETA on v0.28?

@mortenpi
Copy link
Member Author

That's my bad -- it did end up in the auto-generated changelog of the GitHub release. The only changelog that matters is what is in CHANGELOG.md. We need to invoke TagBot in a way that it doesn't generate its own release notes -- they're not correct if you have a multi-branch backport workflow.

As for 0.28: I wouldn't want to put a date to it. There are a couple of fixes that should go in first that I haven't had the chance to tackle yet. However, you can always add a Manifest and use the master branch of Documenter, if you want to take advantage of the latest features (e.g. like is done for this package: https://juliaatoms.org/AngularMomentumAlgebra.jl/stable/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants