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

Fix documentation search engine #1401

Merged
merged 23 commits into from
Feb 16, 2024
Merged

Fix documentation search engine #1401

merged 23 commits into from
Feb 16, 2024

Conversation

jorgepiloto
Copy link
Member

Continuation of #1400 since it looks like the generated pages are missing the Meilisearch data.

Copy link

codecov bot commented Feb 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9e3f3f1) 87.84% compared to head (dfe7995) 87.84%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1401   +/-   ##
=======================================
  Coverage   87.84%   87.84%           
=======================================
  Files          81       81           
  Lines        9543     9543           
=======================================
  Hits         8383     8383           
  Misses       1160     1160           

@jorgepiloto
Copy link
Member Author

It looks like the environment variable is being passed. However, the search bar only shows up in this page: https://dpf.docs.pyansys.com/version/stable/search.html

@jorgepiloto
Copy link
Member Author

I am suspecting now about the Sphinx version.

@Revathyvenugopal162
Copy link
Contributor

docs build will only trigger if the PR is not draft, so changing the PR from draft to test

@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review February 15, 2024 12:58
PProfizi and others added 10 commits February 15, 2024 15:54
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@Revathyvenugopal162
Copy link
Contributor

i reverted the sphinx version back to 5.3.0 and the ci passes. we need to
investigate further to see the issue with the sphinx upgraded version.

@Revathyvenugopal162
Copy link
Contributor

Revathyvenugopal162 commented Feb 16, 2024

The build failed with Sphinx 7.2.6, prompting me to switch to version 7.1.0. The underlying issue with the search bar was that the 'pydata sphinx theme' was mistakenly included as an extension in the 'conf.py' file, causing it to override the desired 'ansys sphinx theme' and consequently affecting the search functionality. Now the search is working , please see the video attached took with artifacts.

pydpf.mp4

@PProfizi and @jorgepiloto thank you for helping on fixing this issue. if you agree we can revert the unwanted changes on this PR and merge this PR.

@PProfizi PProfizi merged commit af82843 into master Feb 16, 2024
40 checks passed
@PProfizi PProfizi deleted the fix/meilisearch branch February 16, 2024 16:52
@PProfizi PProfizi changed the title ci: investigations Fix documentation search engine Feb 16, 2024
@PProfizi PProfizi added the documentation Improvements or additions to documentation label Feb 16, 2024
@PProfizi PProfizi added this to the v0.11.0 milestone Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants