Qiskit / Qiskit/documentation

Allow searching in a specific API reference

Open
#3,603 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design 🎨 UI feedback
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant documentation

No response

Please describe the UI problem or feature request.

It seems that I cannot search within the API reference for a particular package. For example, I wanted to search for backend target, which I know is a Qiskit (core) class. But there is no option to search just the Qiskit API reference, so the first results were about AQC-Tensor Qiskit Addon.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reproducing a search for “backend target” and inspect how the documentation search handles API references and package boundaries. Done means users can restrict searches to a particular API reference and receive relevant package results.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.