Skip to content

ENH: softlink current docs - #29

Closed
jklymak wants to merge 2 commits into
matplotlib:masterfrom
jklymak:enh-softlink-current-docs
Closed

jklymak wants to merge 2 commits into
matplotlib:masterfrom
jklymak:enh-softlink-current-docs

Conversation

@jklymak

@jklymak jklymak commented Feb 28, 2019

Copy link
Copy Markdown
Member

This (big-looking) PR actually just does one simple thing:

ln -s 3.0.2 latest
rm -rf gallery # etc....
ln -s latest/gallery gallery  # etc

So basically all calls to matplotlib.org/index.html show up as matplotlib.org/3.0.2/index.html. If we want to link latest, you can always link matplotlib.org/latest/index.html; Someone who deploys the docs will need to update the softlink of course when a new version is released.

@tacaswell

Copy link
Copy Markdown
Member

This won't solve the problem we currently have when new version of the docs add or remove files, it just uses symlinks instead of copying.

@jklymak

jklymak commented Feb 28, 2019 •

Copy link
Copy Markdown
Member Author

The link will be to matplotlib.org/3.0.2/file_that_gets_moved_in_3.1.html so the version is in the name and at the top of the page. This is how python.org does it so far as I can tell.

@jklymak

jklymak commented Feb 28, 2019

Copy link
Copy Markdown
Member Author

Its possible to get to
matplotlib.org/file_that_gets_moved_in_3.1.html, so I guess thats a drawback. But you'd have to manually go there.

@tacaswell

Copy link
Copy Markdown
Member

It is not clear to me that the url is actually going to change/auto-forward. From the servers point of view file.html still exists, that it gets that by following a symlink should be opaque to it....

@jklymak

jklymak commented Feb 28, 2019

Copy link
Copy Markdown
Member Author

Fair enough - afraid I don't have a static github pages page (mine renders in jekyl). Would it be a problem to push a test subdir?

@jklymak

jklymak commented Mar 1, 2019

Copy link
Copy Markdown
Member Author

OK Closing because this method of redirects doesn't work. Its pretty tough to do anything flexibly from a static GitHub page...

@jklymak jklymak closed this Mar 1, 2019
@jklymak
jklymak deleted the enh-softlink-current-docs branch March 1, 2019 01:38
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

Successfully merging this pull request may close these issues.

2 participants