55 lines
1.6 KiB
Plaintext
55 lines
1.6 KiB
Plaintext
---
|
||
title: api_example
|
||
description: API reference for api_example
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: api_example
|
||
---
|
||
|
||
<span id="api-example-api-example" />
|
||
|
||
<span id="module-api_example" />
|
||
|
||
# API example
|
||
|
||
<span id="module-api_example" />
|
||
|
||
`api_example`
|
||
|
||
Welcome to my super cool module!
|
||
|
||
<Admonition title="Note" type="note">
|
||
This is an example!
|
||
</Admonition>
|
||
|
||
Testing internal references… [`Electron.compute_momentum()`](api_example.Electron#compute_momentum "api_example.Electron.compute_momentum").
|
||
|
||
## Contents
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------ | ----------------------------------- |
|
||
| [`Electron`](api_example.Electron "api_example.Electron")(\[size, name]) | A representation of an electron. |
|
||
| [`my_function1`](api_example.my_function1 "api_example.my_function1")(input1, input2\[, input3]) | A function that does awesome stuff. |
|
||
|
||
## Functions
|
||
|
||
### my\_function2
|
||
|
||
<Function id="api_example.my_function2" github="https://github.com/Qiskit/qiskit_sphinx_theme/tree/stable/0.1/api_example.py" signature="api_example.my_function2(input1, input2, input3=None, **kwargs)">
|
||
A function that does awesome stuff.
|
||
|
||
**Returns**
|
||
|
||
Did the function work.
|
||
|
||
**Raises**
|
||
|
||
* **ValueError** – If the inputs are not the correct values.
|
||
* **TypeError** – If the inputs are not strings.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Function>
|
||
|