Skip to content

Commit 8ef73e4

Browse files
committed
docs(API): Break up API pages more
1 parent 2e7cfc7 commit 8ef73e4

File tree

5 files changed

+22
-140
lines changed

5 files changed

+22
-140
lines changed

docs/internals/index.md

Lines changed: 2 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -8,147 +8,9 @@ These APIs are internal and not covered by versioning policy.
88

99
:::
1010

11-
```{module} libtmux
11+
```{toctree}
1212
13-
```
14-
15-
## Common
16-
17-
```{eval-rst}
18-
.. autodata:: libtmux.common.TMUX_MIN_VERSION
19-
```
20-
21-
```{eval-rst}
22-
.. autodata:: libtmux.common.TMUX_MAX_VERSION
23-
```
24-
25-
```{eval-rst}
26-
.. autoclass:: libtmux.common.TmuxRelationalObject
27-
:members:
28-
```
29-
30-
```{eval-rst}
31-
.. autoclass:: libtmux.common.TmuxMappingObject
32-
:members:
33-
```
34-
35-
```{eval-rst}
36-
.. autoclass:: libtmux.common.EnvironmentMixin
37-
:members:
38-
```
39-
40-
```{eval-rst}
41-
.. autoclass:: libtmux.common.tmux_cmd
42-
```
43-
44-
```{eval-rst}
45-
.. automethod:: libtmux.common.which
46-
```
47-
48-
### Version
49-
50-
```{eval-rst}
51-
.. automethod:: libtmux.common.get_version
52-
```
53-
54-
```{eval-rst}
55-
.. automethod:: libtmux.common.has_version
56-
```
57-
58-
```{eval-rst}
59-
.. automethod:: libtmux.common.has_gt_version
60-
```
61-
62-
```{eval-rst}
63-
.. automethod:: libtmux.common.has_gte_version
64-
```
65-
66-
```{eval-rst}
67-
.. automethod:: libtmux.common.has_lt_version
68-
```
69-
70-
```{eval-rst}
71-
.. automethod:: libtmux.common.has_lte_version
72-
```
73-
74-
```{eval-rst}
75-
.. automethod:: libtmux.common.has_minimum_version
76-
```
77-
78-
```{eval-rst}
79-
.. automethod:: libtmux.common.handle_option_error
80-
```
81-
82-
```{eval-rst}
83-
.. automethod:: libtmux.common.get_libtmux_version
84-
```
85-
86-
## Exceptions
87-
88-
```{eval-rst}
89-
.. autoexception:: libtmux.exc.LibTmuxException
90-
```
91-
92-
```{eval-rst}
93-
.. autoexception:: libtmux.exc.TmuxCommandNotFound
94-
```
95-
96-
```{eval-rst}
97-
.. autoexception:: libtmux.exc.VersionTooLow
98-
```
99-
100-
```{eval-rst}
101-
.. autoexception:: libtmux.exc.TmuxSessionExists
102-
```
103-
104-
```{eval-rst}
105-
.. autoexception:: libtmux.exc.BadSessionName
106-
```
107-
108-
```{eval-rst}
109-
.. autoexception:: libtmux.exc.OptionError
110-
```
111-
112-
```{eval-rst}
113-
.. autoexception:: libtmux.exc.UnknownOption
114-
```
115-
116-
```{eval-rst}
117-
.. autoexception:: libtmux.exc.InvalidOption
118-
```
119-
120-
```{eval-rst}
121-
.. autoexception:: libtmux.exc.AmbiguousOption
122-
```
123-
124-
## Test tools
125-
126-
```{eval-rst}
127-
.. automethod:: libtmux.test.retry
128-
```
129-
130-
```{eval-rst}
131-
.. automethod:: libtmux.test.retry_until
132-
```
133-
134-
```{eval-rst}
135-
.. automethod:: libtmux.test.get_test_session_name
136-
```
137-
138-
```{eval-rst}
139-
.. automethod:: libtmux.test.get_test_window_name
140-
```
141-
142-
```{eval-rst}
143-
.. automethod:: libtmux.test.temp_session
144-
```
145-
146-
```{eval-rst}
147-
.. automethod:: libtmux.test.temp_window
148-
```
149-
150-
```{eval-rst}
151-
.. autoclass:: libtmux.test.EnvironmentVarGuard
13+
test
15214
```
15315

15416
## Environmental variables

docs/internals/test.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Test helpers
2+
3+
```{eval-rst}
4+
.. autoapimodule:: libtmux.test
5+
:members:
6+
```

docs/reference/common.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Utilities
2+
3+
```{eval-rst}
4+
.. autoapimodule:: libtmux.common
5+
:members:
6+
```

docs/reference/exceptions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Exceptions
2+
3+
```{eval-rst}
4+
.. autoapimodule:: libtmux.exc
5+
:members:
6+
```

docs/reference/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ servers
1111
sessions
1212
windows
1313
panes
14+
common
15+
exceptions
1416
```

0 commit comments

Comments
 (0)