-
-
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
Search: remove non-generic parser code #10676
Conversation
Closes #10272. We can't remove the code that generates the fjson files, since they are being used by the embed API (v2), that API is mentioned as deprecated, we should do the actual deprecation by contacting projects using it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! I'm super happy we are simplifying our platform a lot.
@@ -1,7 +1,20 @@ | |||
<!DOCTYPE html> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand the HTML files has to be valid HTML now to be able to parse them, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, previously these were just an extract of the full document.
"path": "autodoc.html", | ||
"title": "sphinx.ext.autodoc – Include documentation from docstrings", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure to understand why these are now returned and they weren't before. Can you expand on that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously the title and path came from the fjson file, now they come from the file itself.
Co-authored-by: Manuel Kaufmann <[email protected]>
Closes #10272.
We can't remove the code that generates the fjson files, since they are being used by the embed API (v2),
that API is mentioned as deprecated,
we should do the actual deprecation by contacting
projects using it.
I went ahead and removed the piece of code of the mkdocs embed API, since it was trying to query fjson files for those projects, but we stopped generating those files for mkdocs a long time ago...