Add back class modifier in front of class signatures

[Eric-Arellano]

This is how Sphinx renders https://docs.quantum.ibm.com/api/qiskit/dev/circuit#bits-and-registers

Vs us:

documentation/docs/api/qiskit/dev/circuit.mdx

Line 260 in eca9f43

<Class id="qiskit.circuit.Bit" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/bit.py#L21-L94" signature="qiskit.circuit.Bit(register=None, index=None)">

Should we add back the class modifier? Should it only be for inline classes, or also dedicated pages like https://docs.quantum.ibm.com/api/qiskit/dev/qiskit.circuit.AnnotatedOperation?

If so, should it be italicized? If it should be italicized, should we add a new attribute to the component like signaturePrefix?

--

What's interesting is some signatures are preserved, like final class and static. Why is this?

documentation/docs/api/qiskit/circuit_classical.mdx

Line 63 in eca9f43

<Class id="qiskit.circuit.classical.expr.Var" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L109-L168" signature="final class qiskit.circuit.classical.expr.Var(var, type)">

documentation/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx

Line 90 in eca9f43

<Function id="qiskit_ibm_runtime.options.Options.validate_options" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.23/qiskit_ibm_runtime/options/options.py#L351-L379" signature="static validate_options(options)">

[Eric-Arellano]

We decided that we do want to do this. We still need to figure out the design. Devs should create a few examples for us to decide:

• class in the code section w/o italics
• class in the code section w/ italics (if possible)
• class before the code section w/o italics
• class before the code section w/ italics

We should audit if there are any other modifiers we've been dropping.

[arnaucasau]

Here are the screenshots with an example of how each design would look like. I added the case where we have the modifier w/ bold in and before the code section.

Inside the code section examples

Option 1. class in the code section

Option 2. class in the code section w/ italics

Option 3. class in the code section w/ bold

Before the code section examples

Option 4. class before the code section

Option 5. class in the code section w/ italics

Option 6. class before the code section w/ bold

[Eric-Arellano]

Closed by @arnaucasau in #1337 🚀