Broken links in documentation and notebooks

[raphaelvallat]

#194 introduced broken links in the documentation, notebooks and external references to YASA (e.g. personal website redirects to https://raphaelvallat.com/yasa/build/html/index.html)

[remrama]

Yikes! Sorry about that @raphaelvallat. Assuming the scope is limited to cases like the example you provided, I think it's just from the hard-coded URLs to YASA's documentation. We no longer need the build/html in the URL.

Your example is fixed by removing that:

# broken
https://raphaelvallat.com/yasa/build/html/index.html

# working
https://raphaelvallat.com/yasa/index.html

A simple search-and-replace should take care of this. Did you notice anything else? Want me to take care of it?

[raphaelvallat]

No problem — I don't have the time to fix it now so I just created this quick issue as a reminder. If you're already working on the updated docs then please feel free to include the fix in your PR, however I'll work on it this weekend. Thanks!

[remrama]

I'll aim for an isolated PR to address this by the end of the day over here on EST.

[remrama]

When replacing hard-coded URLs, should I go ahead and change all raphaelvallat.com/yasa to raphaelvallat.github.io/yasa? (Basically just replace .com with .github.io.) The latter will always redirect to whatever custom URL we have set, so it seems like it would better handle any upcoming changes in that regard? Thinking of #200.

This makes sense to me unless there is a cost of frequent redirects that I'm not aware of.

[remrama]

Another concern is that google searches still provide the build/html index link, taking people to broken site from google search. Same goes for bookmarks and autofills for people who visit the site frequently.

So now the main task should be to get a obal configuration in sphinx that can temporarily redirect from the build/html link to the shorter one. I presume there is a way to do this, not sure of it yet though.

I didn't think about the global change in URL structure and its consequences for the new pydata sphinx setup. Note these same concerns will apply to #200 if/when that changes, so consider this a trial run for that!

[remrama]

Another realization. The broken landing page is the default sphinx docs 404 page (which is essentially an uninformative nothing). So the sphinx-notfound-page extension is not currently working correctly. That extension is supposed to add a common 404 page that better matches the custom site design.

Whatever solution we implement to solve the current Issue should naturally address that, either utilizing the next 404 page to dynamically redirect, redirect to the new docs index, or add a custom message letting people know of the update.

[raphaelvallat]

Thanks @remrama for thinking this through! Please feel free to replace all .com links with raphaelvallat.github.io/yasa

So now the main task should be to get a global configuration in sphinx that can temporarily redirect from the build/html link to the shorter one. I presume there is a way to do this, not sure of it yet though.

Good question, I don't know either 🤔