Mark stale docs at top-level with warning banner#25

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

JazzTap wants to merge2 commits intomatplotlib:masterfromJazzTap:warn-toplevel

Closed

Mark stale docs at top-level with warning banner#25

JazzTap wants to merge2 commits intomatplotlib:masterfromJazzTap:warn-toplevel

Conversation

Copy link

JazzTap commentedJul 17, 2018•
edited
Loading

Here's another horrifying (but orthogonal) script-generated commit, building upon 'cleanup.py' (-> 'cleanup.ipynb'). It deprecates any HTML in the following folders which doesn't appear in the (given, in this case '2.2.2') current release.

'gallery', 'examples', 'mpl_examples', 'plot_directive', 'devel', 'users', 'api', 'faq', 'glossary'

'Deprecation' means putting a sticky red banner in, with a suggested search string. Bots arenot forwarded (via rel='canonical') because we don't know where the content went. Even if the page has obviously just been refiled (e.g. tight layout guide), we punt to the search engine to do the fuzzy match.

Stale .py or .pdf (but not .png, e.g. in _images) files found in top-level (unversioned) docs are removed. This does break outdated examples' 'Source code' links. (Also, we could check HTML title elements for the outdated version string.)

Edit: Oops, rerunning the script not only stacks 'unreleased-message' banners but is its main use case, fixing tomorrow. Will alias the style ('stale-docs-message') too.