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 old versions of the documentation from being indexed by Google #3263

Closed
hierophect opened this issue Aug 11, 2020 · 1 comment · Fixed by #3291
Closed

Prevent old versions of the documentation from being indexed by Google #3263

hierophect opened this issue Aug 11, 2020 · 1 comment · Fixed by #3291

Comments

@hierophect
Copy link
Collaborator

A common issue when searching for Circuitpython's ReadTheDocs hosted documentation is that the pages for module APIs returned by Google are often very old, sometimes even going back to version 3.x or even 2.x. A prominent warning has been added to these pages to prevent users confusing old APIs for current ones, but a better solution would be to prevent these pages from being indexed by search engines altogether.

I found a Github issue for readthedocs started by the Astropy project that mirrors this exact issue. This conversation indicates a solution is possible, documented here: https://docs.readthedocs.io/en/latest/faq.html#how-can-i-avoid-search-results-having-a-deprecated-version-of-my-docs

An example of Astropy's implementation of this feature is in their PR here: astropy/astropy#8383

@hierophect
Copy link
Collaborator Author

@kattni @sommersoft pinging for your attention.

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

Successfully merging a pull request may close this issue.

3 participants