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

Merged
merged 3 commits into from Jun 6, 2018

Conversation

Projects
None yet
5 participants
@davidfischer
Contributor

davidfischer commented Apr 30, 2018

This does a few smaller changes to mkdocs:

  • Updates mkdocs to the latest version 0.17.3
  • cat mkdocs.yml so it appears in the build logs like conf.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 a theme_dir setting in the mkdocs.yml. Now there is a theme setting which is a dict with name, 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.

davidfischer added some commits Apr 30, 2018

@agjohnson

This comment has been minimized.

Contributor

agjohnson commented May 3, 2018

What's the status of mkdocs search on RTD with a modern version?

@agjohnson agjohnson added this to the 2.4 milestone May 3, 2018

@davidfischer

This comment has been minimized.

Contributor

davidfischer commented May 3, 2018

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

@PowerKiKi

This comment has been minimized.

Contributor

PowerKiKi commented May 9, 2018

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.

@stsewd

This comment has been minimized.

Member

stsewd commented May 10, 2018

Maybe this is solved here? (or maybe to consider) #3174

@agjohnson agjohnson modified the milestones: 2.4, 2.5 May 31, 2018

@ericholscher

This comment has been minimized.

Member

ericholscher commented Jun 6, 2018

@stsewd did you test your other PR (#4184) with this version of mkdocs to confirm? I think we can probably merge this, but might have some support fallout from stuff we weren't doing in a smart way. This is just the default though, so users might already have upgraded.

@stsewd

This comment has been minimized.

Member

stsewd commented Jun 6, 2018

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 :)

@ericholscher ericholscher merged commit 00509b0 into rtfd:master Jun 6, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@ericholscher

This comment has been minimized.

Member

ericholscher commented Jun 6, 2018

Great, let's go ahead and ship it then :)

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