Populate search user guide

[andypbarrett]

This is a PR to populate the User-Guide Search pages and resolves Issue 852

The page describes search_datasets, search_data and search_services.

I've opened it as a Draft PR.

In addition to the User-Guide pages, the docstrings for each of these methods in earthaccess.api need to be complete. Issue 345

Pull Request (PR) draft checklist - click to expand

• Please review our
  contributing documentation
  before getting started.
• Populate a descriptive title. For example, instead of "Updated README.md", use a
  title such as "Add testing details to the contributor section of the README".
  Example PRs: #763
• Populate the body of the pull request with:
  • A clear description of the change you are proposing.
  • Links to any issues resolved by this PR with text in the PR description, for
    example closes #1. See
    GitHub docs - Linking a pull request to an issue.
• Update CHANGELOG.md with details about your change in a section titled
  ## Unreleased. If such a section does not exist, please create one. Follow
  Common Changelog for your additions.
  Example PRs: #763
• Update the documentation and/or the README.md with details of changes to the
  earthaccess interface, if any. Consider new environment variables, function names,
  decorators, etc.

Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!

Pull Request (PR) merge checklist - click to expand

Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the @nsidc/earthaccess-support team in a comment and we
will help you out!

• Add unit tests for any new features.
• Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
  Request containing "pre-commit.ci autofix" to automate this.
• Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
• Get at least one approving review.

---

📚 Documentation preview 📚: https://earthaccess--1035.org.readthedocs.build/en/1035/

[github-actions]

👈 Launch a binder notebook on this branch for commit 303d1c0

I will automatically update this comment whenever this PR is modified

👈 Launch a binder notebook on this branch for commit 346fca4

👈 Launch a binder notebook on this branch for commit 004db05

👈 Launch a binder notebook on this branch for commit cbe6669

👈 Launch a binder notebook on this branch for commit 706928f

[chuckwondo]

@andypbarrett, a handful of PRs have been merged yesterday and today, so I merged main into this branch. Everything looks good, but pre-commit found a couple of things for you to address: https://results.pre-commit.ci/run/github/399867529/1750949734.9P5fEvIaSeOOcC9gwNe0Pw

To reduce the likelihood of pre-commit failing in CI, you can run it locally to identify issues before you push your changes.

If you have uv installed, you can simply run uv run pre-commit run -a.

If you are using a python or conda env, you simply need to activate your environment, then run pre-commit run -a.

[andypbarrett]

In progress:

• added (I think) complete list of kwargs to search_datasets.
• added text and examples to search.md

[mfisher87]

Instead of listing out the kwargs, how do you feel about linking to the API documentation for the full list of kwargs? Then we just need to keep one place (docstring) updated with high quality descriptions:

earthaccess/earthaccess/api.py

Line 95 in e2f4bae

def search_datasets(count: int = -1, **kwargs: Any) -> List[DataCollection]:

[andypbarrett]

@mfisher87 is this what you are thinking of.

The list in user-guide/search.md is a placeholder while I was collecting kwargs into one place. My plan is to remove that list after I have completed the kwargs list for search_data.

[andypbarrett]

Qu. I would like to include the examples in the docstrings and in the user guides in the testing framework. Is there an accepted way to do this?