Skip to content

Commit ededdb8

Browse files
committed
docs(internals): add SparseArray doc page
why: SparseArray internal API had no documentation page. what: - Create docs/internals/sparse_array.md with automodule directive - Add sparse_array to docs/internals/index.md toctree
1 parent ea47955 commit ededdb8

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/internals/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
1212
dataclasses
1313
query_list
1414
constants
15+
sparse_array
1516
```
1617

1718
## Environmental variables

docs/internals/sparse_array.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Internal Sparse Array - `libtmux._internal.sparse_array`
2+
3+
:::{warning}
4+
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions!
5+
6+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/libtmux/issues).
7+
:::
8+
9+
```{eval-rst}
10+
.. automodule:: libtmux._internal.sparse_array
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
```

0 commit comments

Comments
 (0)