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

Switch documentation search to use Algolia #224

Merged
merged 9 commits into from
Apr 19, 2023
Merged

Conversation

bandish-shah
Copy link
Collaborator

Description of changes:

This PR switches the default documentation search engine to be Algolia. Along for the ride it also fixes some indentation warnings in docstrings.

Issue #, if available:

N/A

Merge Checklist:

Put an x without space in the boxes that apply. If you are unsure about any checklist, please don't hesitate to ask. We are here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the contributor guidelines
  • This is a documentation change or typo fix. If so, skip the rest of this checklist.
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the MosaicML team.
  • I have updated any necessary documentation, including README and API docs (if appropriate).

Tests

  • I ran pre-commit on my change. (check out the pre-commit section of prerequisites)
  • I have added tests that prove my fix is effective or that my feature works (if appropriate).
  • I ran the tests locally to make sure it pass. (check out testing)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes.

streaming/base/dataset.py Outdated Show resolved Hide resolved
streaming/base/stream.py Outdated Show resolved Hide resolved
@bandish-shah bandish-shah enabled auto-merge (squash) April 18, 2023 04:26
@bandish-shah bandish-shah merged commit d54acc9 into main Apr 19, 2023
@bandish-shah bandish-shah deleted the bandish/algolia_search branch April 19, 2023 04:52
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.

3 participants