8000 docs(api/internals): Add colors and private_path module documentation · tmux-python/tmuxp@e7abc7f · GitHub
[go: up one dir, main page]
Skip to content

Commit e7abc7f

Browse files
tonytony
committed
docs(api/internals): Add colors and private_path module documentation
1 parent 101fe64 commit e7abc7f

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

‎docs/api/internals/colors.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Colors - `tmuxp._internal.colors`
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/tmuxp/issues).
7+
:::
8+
9+
```{eval-rst}
10+
.. automodule:: tmuxp._internal.colors
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
```

‎docs/api/internals/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ If you need an internal API stabilized please [file an issue](https://github.com
99
:::
1010

1111
```{toctree}
12+
colors
1213
config_reader
14+
private_path
1315
types
1416
```

‎docs/api/internals/private_path.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Private path - `tmuxp._internal.private_path`
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/tmuxp/issues).
7+
:::
8+
9+
```{eval-rst}
10+
.. automodule:: tmuxp._internal.private_path
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
```

0 commit comments

Comments
 (0)
0