Skip to content

Commit 2e7cfc7

Browse files
committed
docs(api): Move internal APIs to reference
1 parent 3b35f50 commit 2e7cfc7

File tree

4 files changed

+17
-54
lines changed

4 files changed

+17
-54
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ api
2828
:hidden:
2929
3030
developing
31+
internals/index
3132
history
3233
glossary
3334
GitHub <https://github.com/tmux-python/libtmux>

docs/api.md renamed to docs/internals/index.md

Lines changed: 11 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,18 @@
1-
(api)=
1+
(internals)=
22

3-
# API Reference
3+
# Internals
44

55
:::{warning}
66

7-
All APIs are considered experimental and subject to break pre-1.0. They can and will break between
8-
versions.
7+
These APIs are internal and not covered by versioning policy.
98

109
:::
1110

1211
```{module} libtmux
1312
1413
```
1514

16-
## Server Object
17-
18-
```{eval-rst}
19-
.. autoapiclass:: Server
20-
:members:
21-
:inherited-members:
22-
:private-members:
23-
:show-inheritance:
24-
:member-order: bysource
25-
```
26-
27-
## Session Object
28-
29-
```{eval-rst}
30-
.. autoapiclass:: Session
31-
:members:
32-
:inherited-members:
33-
:private-members:
34-
:show-inheritance:
35-
:member-order: bysource
36-
```
37-
38-
## Window Object
39-
40-
```{eval-rst}
41-
.. autoapiclass:: Window
42-
:members:
43-
:inherited-members:
44-
:private-members:
45-
:show-inheritance:
46-
:member-order: bysource
47-
```
48-
49-
## Pane Object
50-
51-
```{eval-rst}
52-
.. autoapiclass:: Pane
53-
:members:
54-
:inherited-members:
55-
:private-members:
56-
:show-inheritance:
57-
:member-order: bysource
58-
```
59-
60-
## Internals
15+
## Common
6116

6217
```{eval-rst}
6318
.. autodata:: libtmux.common.TMUX_MIN_VERSION
@@ -68,28 +23,30 @@ versions.
6823
```
6924

7025
```{eval-rst}
71-
.. autoapiclass:: libtmux.common.TmuxRelationalObject
26+
.. autoclass:: libtmux.common.TmuxRelationalObject
7227
:members:
7328
```
7429

7530
```{eval-rst}
76-
.. autoapiclass:: libtmux.common.TmuxMappingObject
31+
.. autoclass:: libtmux.common.TmuxMappingObject
7732
:members:
7833
```
7934

8035
```{eval-rst}
81-
.. autoapiclass:: libtmux.common.EnvironmentMixin
36+
.. autoclass:: libtmux.common.EnvironmentMixin
8237
:members:
8338
```
8439

8540
```{eval-rst}
86-
.. autoapiclass:: libtmux.common.tmux_cmd
41+
.. autoclass:: libtmux.common.tmux_cmd
8742
```
8843

8944
```{eval-rst}
9045
.. automethod:: libtmux.common.which
9146
```
9247

48+
### Version
49+
9350
```{eval-rst}
9451
.. automethod:: libtmux.common.get_version
9552
```
@@ -191,7 +148,7 @@ versions.
191148
```
192149

193150
```{eval-rst}
194-
.. autoapiclass:: libtmux.test.EnvironmentVarGuard
151+
.. autoclass:: libtmux.test.EnvironmentVarGuard
195152
```
196153

197154
## Environmental variables

docs/redirects.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
"windows.md" "reference/windows.md"
55
"traversal.md" "topics/traversal.md"
66
"sessions.md" "reference/sessions.md"
7+
"api.md" "internals/index.md"

docs/reference/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
(api)=
2+
3+
(reference)=
4+
15
# Reference
26

37
```{toctree}

0 commit comments

Comments
 (0)