-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Update mkdocs to the latest #4041
Conversation
What's the status of mkdocs search on RTD with a modern version? |
I don't know exactly. Was it not working before? MkDocs (the project) is built with a recent version and here are the search results: http://mkdocs.readthedocs.io/en/stable/search.html?q=something |
Search was indeed not working and a workaround was to inject javascript. For the record, the workaround was also implemented in PHPOffice/PhpSpreadsheet@5df6680. And PhpSpreadsheet also suffers from the broken edit link in the header (#3991). If this PR can solve both issues, that would be awesome. |
Maybe this is solved here? (or maybe to consider) #3174 |
I was following the latest docs from mkdocs so I think shouldn't be a problem. I no quite understand the rest of your comment. After this is merged, I can rebase and overlap with the other feature, also add more tests for mkdocs there :) |
Great, let's go ahead and ship it then :) |
This does a few smaller changes to mkdocs:
cat mkdocs.yml
so it appears in the build logs likeconf.py
. This should make issues with MkDocs easier to debug.In the 0.17.0 version of MkDocs, there were some changes to how themes are configured. Essentially previously, there was a
theme
setting and atheme_dir
setting in themkdocs.yml
. Now there is atheme
setting which is a dict withname
,custom_dir
, and other settings. We need to support both of these in the event they are building with an older version of mkdocs by pinning it in their requirements.Should fix #3991.