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

Update all doclinks from latest to dev #529

Closed
ChrisRackauckas opened this issue Nov 22, 2019 · 14 comments
Closed

Update all doclinks from latest to dev #529

ChrisRackauckas opened this issue Nov 22, 2019 · 14 comments

Comments

@ChrisRackauckas
Copy link
Member

ChrisRackauckas commented Nov 22, 2019

https://github.com/JuliaDocs/Documenter.jl/blob/master/CHANGELOG.md

BREAKING Documenter no longer creates a symlink between the old latest url to specified devurl. (#1151)

JuliaDocs/Documenter.jl#1151

We will need help to actually upgrade here correctly.

@ChrisRackauckas
Copy link
Member Author

@fredrikekre how can we add in that symlink manually?

@mortenpi
Copy link

It's already there and won't go anywhere: https://github.com/JuliaDiffEq/DiffEqDocs.jl/blob/gh-pages/latest

@fredrikekre
Copy link

Unless you manually remove it it will stay.

@ChrisRackauckas
Copy link
Member Author

Got it. Great thanks!

@ChrisRackauckas
Copy link
Member Author

so it's just, new docs will never have it?

@mortenpi
Copy link

so it's just, new docs will never have it?

If you mean new docs as in docs for a new package, then yes.

By the way, you can also set devurl = "latest" if you wanna stick to the old convention.

@fredrikekre
Copy link

so it's just, new docs will never have it?

Yes. If you start a new repository.

If you prefer latest you can just pass devurl="latest" to makedocs though.

See JuliaLang/julia#26825 (comment) for some discussion. IMO latest is misleading, hence why we changed the default to dev.

@mortenpi
Copy link

pass devurl="latest" to makedocs though.

deploydocs*

@ChrisRackauckas
Copy link
Member Author

@fredrikekre
Copy link

@ChrisRackauckas
Copy link
Member Author

so just format = Documenter.HTML(analytics = "UA-90474609-3",canonical="stable")?

@fredrikekre
Copy link

fredrikekre commented Nov 22, 2019

I believe canonical must be an absolute URL.

@ChrisRackauckas
Copy link
Member Author

format = Documenter.HTML(analytics = "UA-90474609-3",canonical="https://docs.juliadiffeq.org/stable/") ?

@fredrikekre
Copy link

Yea, looks ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants