1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
|
# {py:mod}`package`
```{py:module} package
```
```{autodoc2-docstring} package
:allowtitles:
```
## Subpackages
```{toctree}
:titlesonly:
:maxdepth: 3
package.a
```
## Package Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`Class <package.Class>`
- ```{autodoc2-docstring} package.Class
:summary:
```
````
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`func <package.func>`
- ```{autodoc2-docstring} package.func
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`__all__ <package.__all__>`
- ```{autodoc2-docstring} package.__all__
:summary:
```
* - {py:obj}`p <package.p>`
- ```{autodoc2-docstring} package.p
:summary:
```
````
### API
````{py:data} __all__
:canonical: package.__all__
:value: >
['p', 'a1', 'alias']
```{autodoc2-docstring} package.__all__
```
````
````{py:data} p
:canonical: package.p
:value: >
1
```{autodoc2-docstring} package.p
```
````
````{py:function} func(a: str, b: int) -> package.a.c.ac1
:canonical: package.func
```{autodoc2-docstring} package.func
```
````
`````{py:class} Class
:canonical: package.Class
```{autodoc2-docstring} package.Class
```
````{py:attribute} x
:canonical: package.Class.x
:type: int
:value: >
1
```{autodoc2-docstring} package.Class.x
```
````
````{py:method} method(a: str, b: int) -> ...
:canonical: package.Class.method
```{autodoc2-docstring} package.Class.method
```
````
````{py:property} prop
:canonical: package.Class.prop
:type: package.a.c.ac1 | None
```{autodoc2-docstring} package.Class.prop
```
````
````{py:class} Nested
:canonical: package.Class.Nested
```{autodoc2-docstring} package.Class.Nested
```
````
`````
|