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

deploydocs should create and maintain redirect index.html? #937

Closed
mortenpi opened this issue Feb 3, 2019 · 5 comments
Closed

deploydocs should create and maintain redirect index.html? #937

mortenpi opened this issue Feb 3, 2019 · 5 comments

Comments

@mortenpi
Copy link
Member

mortenpi commented Feb 3, 2019

Most Documenter setups have an index.html file like this

<meta http-equiv="refresh" content="0; url=http://juliadocs.github.io/Documenter.jl/stable"/>

in the root of the gh-pages branch to redirect to the latest stable version of the docs. Should deploydocs just create this file automatically? Possibly with an option to disable this if the user wants to maintain their own index.html.

The behavior could be as follows:

  • If there are tagged versions, have index.html point to stable/.
  • If there are not tagged version, have it point to dev/.

Related: #264

@fredrikekre
Copy link
Member

Makes sense. I think most packages don't have that file at all though?

@fredrikekre
Copy link
Member

We can have a Documenter specific header and only modify it if it was indeed generated by Documenter.

@kellertuer
Copy link

kellertuer commented Jun 4, 2019

It seems my instance does not (yet?) create the index.html automatically. Do I have to activate that? It would be handy because until now only the stable/ link works – well “only” – that one works perfectly fine and great :)
edit: Ah I think I managed to add the file myself and it seems to work. An option that Documenter could add that file would be awesome, too :)

@christopher-dG
Copy link
Contributor

Bump, I would very much like this feature. I've been pasting an index.html in manually for a bunch of packages but I'd prefer to have it handled for me, especially if it can properly choose between /dev and /stable!

@mortenpi
Copy link
Member Author

mortenpi commented Aug 1, 2021

Fixed by #1657.

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

No branches or pull requests

4 participants