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 header hierarchy for the API docs #1283

Merged
merged 44 commits into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
94cc65c
detect prior header level
arnaucasau May 2, 2024
455e01d
properties headers and replace CSS class for data
arnaucasau May 2, 2024
c291ec3
new comments and fmt
arnaucasau May 2, 2024
e71ebea
Merge branch 'main' into AC/header-levels
arnaucasau May 2, 2024
f560bbf
Merge branch 'main' into AC/header-levels
arnaucasau May 3, 2024
72caa4e
set 3 as the minimum header level for the components
arnaucasau May 3, 2024
b473e96
Merge branch 'main' into AC/header-levels
arnaucasau May 3, 2024
c014686
Regenerate qiskit 0.19.6
arnaucasau May 3, 2024
2575f02
Regenerate qiskit 0.24.1
arnaucasau May 3, 2024
faa14b5
Regenerate qiskit 0.25.4
arnaucasau May 3, 2024
c94fd84
Regenerate qiskit 0.26.2
arnaucasau May 3, 2024
4e1bb0a
Regenerate qiskit 0.27.0
arnaucasau May 3, 2024
3295680
Regenerate qiskit 0.28.0
arnaucasau May 3, 2024
1a65ef9
Regenerate qiskit 0.29.1
arnaucasau May 3, 2024
164a5ec
Regenerate qiskit 0.30.1
arnaucasau May 3, 2024
9c9a3e1
Regenerate qiskit 0.31.0
arnaucasau May 3, 2024
fbec06a
Regenerate qiskit 0.32.1
arnaucasau May 3, 2024
009f756
Regenerate qiskit 0.33.1
arnaucasau May 3, 2024
f34b4e7
Regenerate qiskit 0.35.0
arnaucasau May 3, 2024
7231332
Regenerate qiskit 0.36.0
arnaucasau May 3, 2024
ec58cbf
Regenerate qiskit 0.37.2
arnaucasau May 3, 2024
e6d7f36
Regenerate qiskit 0.38.0
arnaucasau May 3, 2024
be01bb4
Regenerate qiskit 0.39.5
arnaucasau May 3, 2024
b9b2e98
Regenerate qiskit 0.40.0
arnaucasau May 3, 2024
44da694
Regenerate qiskit 0.41.0
arnaucasau May 3, 2024
e914932
Regenerate qiskit 0.42.0
arnaucasau May 3, 2024
c4ed4e3
Regenerate qiskit 0.43.0
arnaucasau May 3, 2024
56554e1
Regenerate qiskit 0.44.0
arnaucasau May 3, 2024
f457a80
Regenerate qiskit 0.45.3
arnaucasau May 3, 2024
58d92b4
Regenerate qiskit 0.46.1
arnaucasau May 3, 2024
6cccec3
Regenerate qiskit 1.0.2
arnaucasau May 3, 2024
c972dba
Regenerate qiskit 1.1.0-dev
arnaucasau May 3, 2024
95566ec
Regenerate qiskit-ibm-provider 0.10.0
arnaucasau May 3, 2024
bbad30a
Regenerate qiskit-ibm-provider 0.9.0
arnaucasau May 3, 2024
11c2b4f
Regenerate qiskit-ibm-provider 0.11.0
arnaucasau May 3, 2024
c7a55dd
fix tests
arnaucasau May 3, 2024
1169111
fix fmt
arnaucasau May 3, 2024
0596446
add new test for the heading levels
arnaucasau May 3, 2024
f9dd377
use tagName variable
arnaucasau May 3, 2024
1bea8c4
Merge branch 'main' into AC/header-levels
arnaucasau May 6, 2024
cc8f256
fix merge
arnaucasau May 6, 2024
ee56dc2
feedback
arnaucasau May 6, 2024
4df612f
add return type
arnaucasau May 6, 2024
b55ac33
Update scripts/lib/api/generateApiComponents.ts
arnaucasau May 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Utility functions related to the IBM Quantum Provider.

Message broker for the Publisher / Subscriber mechanism

### Publisher

<Class id="qiskit_ibm_provider.utils.pubsub.Publisher" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L140-L155" signature="Publisher">
Represents a “publisher”.

Expand All @@ -51,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism
Publisher().publish("event", args, ... )
```

### publish
#### publish

<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.
Expand All @@ -62,12 +64,14 @@ Message broker for the Publisher / Subscriber mechanism
</Function>
</Class>

### Subscriber

<Class id="qiskit_ibm_provider.utils.pubsub.Subscriber" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L158-L182" signature="Subscriber">
Represents a “subscriber”.

Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.

### clear
#### clear

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
Unsubscribe everything
Expand All @@ -77,7 +81,7 @@ Message broker for the Publisher / Subscriber mechanism
`None`
</Function>

### subscribe
#### subscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.
Expand All @@ -89,7 +93,7 @@ Message broker for the Publisher / Subscriber mechanism
`bool`
</Function>

### unsubscribe
#### unsubscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.
Expand Down
12 changes: 8 additions & 4 deletions docs/api/qiskit-ibm-provider/0.9/ibm_utils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Utility functions related to the IBM Quantum Provider.

Message broker for the Publisher / Subscriber mechanism

### Publisher

<Class id="qiskit_ibm_provider.utils.pubsub.Publisher" github="https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py" signature="Publisher">
Represents a “publisher”.

Expand All @@ -51,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism
Publisher().publish("event", args, ... )
```

### publish
#### publish

<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" signature="publish(event, *args, **kwargs)">
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.
Expand All @@ -62,12 +64,14 @@ Message broker for the Publisher / Subscriber mechanism
</Function>
</Class>

### Subscriber

<Class id="qiskit_ibm_provider.utils.pubsub.Subscriber" github="https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py" signature="Subscriber">
Represents a “subscriber”.

Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.

### clear
#### clear

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" signature="clear()">
Unsubscribe everything
Expand All @@ -77,7 +81,7 @@ Message broker for the Publisher / Subscriber mechanism
`None`
</Function>

### subscribe
#### subscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" signature="subscribe(event, callback)">
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.
Expand All @@ -89,7 +93,7 @@ Message broker for the Publisher / Subscriber mechanism
`bool`
</Function>

### unsubscribe
#### unsubscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" signature="unsubscribe(event, callback)">
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.
Expand Down
12 changes: 8 additions & 4 deletions docs/api/qiskit-ibm-provider/ibm_utils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Utility functions related to the IBM Quantum Provider.

Message broker for the Publisher / Subscriber mechanism

### Publisher

<Class id="qiskit_ibm_provider.utils.pubsub.Publisher" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L140-L155" signature="Publisher">
Represents a “publisher”.

Expand All @@ -51,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism
Publisher().publish("event", args, ... )
```

### publish
#### publish

<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.
Expand All @@ -62,12 +64,14 @@ Message broker for the Publisher / Subscriber mechanism
</Function>
</Class>

### Subscriber

<Class id="qiskit_ibm_provider.utils.pubsub.Subscriber" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L158-L182" signature="Subscriber">
Represents a “subscriber”.

Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.

### clear
#### clear

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
Unsubscribe everything
Expand All @@ -77,7 +81,7 @@ Message broker for the Publisher / Subscriber mechanism
`None`
</Function>

### subscribe
#### subscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.
Expand All @@ -89,7 +93,7 @@ Message broker for the Publisher / Subscriber mechanism
`bool`
</Function>

### unsubscribe
#### unsubscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.11/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/qiskit/0.19/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ python_api_name: qiskit.ignis.logging
| [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")() | Singleton class to configure file logging via IgnisLogger |
| [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files |

###
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved

<Class github="https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py" signature="IgnisLogger(name, level=0)">
A logger class for Ignis

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,42 +30,44 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp
| ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- |
| [`TspData`](#qiskit.optimization.applications.ising.tsp.TspData "qiskit.optimization.applications.ising.tsp.TspData")(name, dim, coord, w) | Create new instance of TspData(name, dim, coord, w) |

### TspData

<Class id="qiskit.optimization.applications.ising.tsp.TspData" signature="TspData(name, dim, coord, w)">
Create new instance of TspData(name, dim, coord, w)

### coord
#### coord

<Attribute id="qiskit.optimization.applications.ising.tsp.TspData.coord">
Alias for field number 2
</Attribute>

### count
#### count

<Function id="qiskit.optimization.applications.ising.tsp.TspData.count" signature="count(value, /)">
Return number of occurrences of value.
</Function>

### dim
#### dim

<Attribute id="qiskit.optimization.applications.ising.tsp.TspData.dim">
Alias for field number 1
</Attribute>

### index
#### index

<Function id="qiskit.optimization.applications.ising.tsp.TspData.index" signature="index(value, start=0, stop=9223372036854775807, /)">
Return first index of value.

Raises ValueError if the value is not present.
</Function>

### name
#### name

<Attribute id="qiskit.optimization.applications.ising.tsp.TspData.name">
Alias for field number 0
</Attribute>

### w
#### w

<Attribute id="qiskit.optimization.applications.ising.tsp.TspData.w">
Alias for field number 3
Expand Down
Loading
Loading