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

Prevent search engines from indexing documentation of old package versions #143

Closed
eonu opened this issue Jan 7, 2021 · 1 comment
Closed

Comments

@eonu
Copy link
Owner

eonu commented Jan 7, 2021

Currently when you search for Sequentia documentation on search engines, the documentation for some of the older package versions is the first to appear. A good example of this is if you search 'dtw knn' on Google, the documentation for the old DTWKNN class from v0.6.1 appears.

This can obviously be confusing for users, so it would be good if we could possibly add a docs/robots.txt file to control what pages are indexed.

astropy/astropy#7874 (and their robots.txt) is a good example of adding this functionality.

Another option is to simply add a warning banner to the top of any documentation page which isn't for the latest package version (example). The sphinx-version-warning Sphinx extension seems to achieve this.

@eonu
Copy link
Owner Author

eonu commented Jan 16, 2021

Addressed in #147.

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

1 participant