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: use external searching #4

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Aug 6, 2024

Description

Doxygen search is... terrible.

This PR adds the ability to use an external search, with custom javascript.

Todo:

  • create javascript class and initialization function, so we don't need to overwrite the original search.js file generated by Doxygen
  • improve javascript table creation
  • improve formatting
  • add custom css to highlight the search terms
  • change default rtd project slug to doxyconfig instead of sunshinestream

Screenshot

image

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

@ReenigneArcher ReenigneArcher force-pushed the fix-use-external-searching branch 15 times, most recently from 743fc8c to 2e591cf Compare August 7, 2024 17:14
@ReenigneArcher ReenigneArcher force-pushed the fix-use-external-searching branch 4 times, most recently from 27e1606 to 8c9407f Compare August 7, 2024 20:32
@ReenigneArcher ReenigneArcher force-pushed the fix-use-external-searching branch from 8c9407f to 0cb84b7 Compare August 7, 2024 20:45
@ReenigneArcher ReenigneArcher marked this pull request as ready for review August 7, 2024 20:48
@ReenigneArcher ReenigneArcher merged commit 6d145da into master Aug 7, 2024
5 checks passed
@ReenigneArcher ReenigneArcher deleted the fix-use-external-searching branch August 7, 2024 20:48
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.

1 participant