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

Remove MkdcocsJson builder #4205

Closed
stsewd opened this issue Jun 7, 2018 · 6 comments
Closed

Remove MkdcocsJson builder #4205

stsewd opened this issue Jun 7, 2018 · 6 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors
Milestone

Comments

@stsewd
Copy link
Member

stsewd commented Jun 7, 2018

Now we use mkdocs 1.7, the json command was removed here https://www.mkdocs.org/about/release-notes/#other-changes-and-additions-to-version-0170

Looks like we aren't using it since I have built some mkdocs projects with no errors (just the html build is reported anyway).

Looks like it is used in the search readthedocs/search/utils.py file.

Here is the unused builder

https://github.com/rtfd/readthedocs.org/blob/b693d56b23f4492a96b55a194c7030f84fc084b7/readthedocs/doc_builder/backends/mkdocs.py#L262-L266

@stsewd stsewd added this to the Cleanup milestone Oct 19, 2018
@stsewd
Copy link
Member Author

stsewd commented Oct 19, 2018

Yup, that's where it needs to be removed.

Actually, I was waiting to see if there are some efforts from the mkdocs side to bring back the json output, but I didn't find anything https://github.com/mkdocs/mkdocs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+json

But, looks like we could have a workaroung to bring search for mkdocs #4588 (comment)

From my side, I think we can remove that code and worry about the future implementation later. Not sure anyway.

@stsewd stsewd added the Needed: design decision A core team decision is required label Oct 19, 2018
@dojutsu-user
Copy link
Member

should I make a PR?

@stsewd
Copy link
Member Author

stsewd commented Oct 19, 2018

I'd wait for another maintainer to confirm

@stsewd stsewd added Accepted Accepted issue on our roadmap Good First Issue Good for new contributors and removed Needed: design decision A core team decision is required labels Apr 27, 2020
@stsewd
Copy link
Member Author

stsewd commented Apr 27, 2020

Unblocking this, the json builder isn't needed to support mkdocs server search #6937

@stsewd
Copy link
Member Author

stsewd commented Apr 29, 2020

This was done in #6937

@stsewd stsewd closed this as completed Apr 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors
Projects
None yet
Development

No branches or pull requests

2 participants