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

Search: remove non-generic parser code #10676

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Search: remove non-generic parser code #10676

merged 4 commits into from
Aug 31, 2023

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Aug 28, 2023

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...

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.
@stsewd stsewd requested review from a team as code owners August 28, 2023 20:28
@stsewd stsewd requested review from humitos and removed request for a team and agjohnson August 28, 2023 20:36
@stsewd stsewd marked this pull request as draft August 28, 2023 20:57
@stsewd stsewd marked this pull request as ready for review August 29, 2023 21:52
Copy link
Member

@humitos humitos left a 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.

readthedocs/embed/views.py Show resolved Hide resolved
@@ -1,7 +1,20 @@
<!DOCTYPE html>
Copy link
Member

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?

Copy link
Member Author

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.

Comment on lines +2 to +3
"path": "autodoc.html",
"title": "sphinx.ext.autodoc – Include documentation from docstrings",
Copy link
Member

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?

Copy link
Member Author

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]>
@stsewd stsewd enabled auto-merge (squash) August 31, 2023 17:04
@stsewd stsewd merged commit 9c6ade2 into main Aug 31, 2023
@stsewd stsewd deleted the remove-old-search-code branch August 31, 2023 17:23
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

Successfully merging this pull request may close these issues.

Search: Only use generic parsers
2 participants