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

Down-ranking the code documentation on readthedocs.org is not working #178

Open
martinburchell opened this issue Dec 17, 2024 · 0 comments

Comments

@martinburchell
Copy link
Collaborator

martinburchell commented Dec 17, 2024

Unfortunately it looks like my attempts either to down-rank or completely ignore the code documentation aren't working. Try searching MPID on https://crateanon.readthedocs.io/en/latest/

Here is the documentation I was following:

https://docs.readthedocs.io/en/stable/config-file/v2.html#search-ranking
https://docs.readthedocs.io/en/stable/config-file/v2.html#search-ignore

Here is the config file:

https://github.com/ucam-department-of-psychiatry/crate/blob/master/.readthedocs.yaml

Here is what I think is the relevant part of the code

https://github.com/readthedocs/readthedocs.org/blob/main/readthedocs/projects/tasks/search.py#L65

This uses fnmatch.fnmatch to test the HTML filenames with the patterns.

Next step is probably to set up a local readthedocs installation with ElasticSearch. Not urgent.

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