Skip to content

Commit 94f507e

Browse files
authored
docs: Move to sphinx-autoissues (#406)
2 parents ebcd049 + 462c7df commit 94f507e

File tree

4 files changed

+101
-103
lines changed

4 files changed

+101
-103
lines changed

CHANGES

+81-77
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,23 @@ $ pip install --user --upgrade --pre libtmux
1212

1313
- _Insert changes/features/fixes for next release here_
1414

15+
### Documentation
16+
17+
- Move to sphinx-autoissues, #406
18+
1519
## libtmux 0.14.2 (2022-08-17)
1620

1721
### Fixes
1822

19-
- {meth}`Server.new_session` _really_ works without `session_name`, {issue}`401` fixes
20-
{issue}`399`. Improved tests and doctests added.
23+
- {meth}`Server.new_session` _really_ works without `session_name`, #401 fixes
24+
#399. Improved tests and doctests added.
2125

2226
## libtmux 0.14.1 (2022-08-17)
2327

2428
### Fixes
2529

26-
- {meth}`Server.new_session` works without `session_name`, {issue}`400` fixes
27-
{issue}`399`
30+
- {meth}`Server.new_session` works without `session_name`, #400 fixes
31+
#399
2832

2933
_This still passed `None` to the session name, this was fixed in v0.14.2._
3034

@@ -33,33 +37,33 @@ $ pip install --user --upgrade --pre libtmux
3337
### Breaking changes
3438

3539
- {meth}`Pane.send_keys`: `suppress_history` default value changed from `True` to
36-
`False`, {issue}`395`
40+
`False`, #395
3741

3842
### Tests and docs
3943

40-
- Initial [doctests] examples stubbed out {issue}`394`
44+
- Initial [doctests] examples stubbed out #394
4145

4246
[doctests]: https://docs.python.org/3/library/doctest.html
4347

44-
- Fix bug in `temp_window()` context manager, {issue}`394`
48+
- Fix bug in `temp_window()` context manager, #394
4549
- Pytest configuration `conftest.py` moved to `libtmux/conftest.py`, so doctest can
46-
detect the fixtures {issue}`394`
50+
detect the fixtures #394
4751

4852
## libtmux 0.13.0 (2022-08-05)
4953

5054
### What's new
5155

5256
- **Improved typings**
5357

54-
Now [`mypy --strict`] compliant ({issue}`383`)
58+
Now [`mypy --strict`] compliant (#383)
5559

56-
Smaller touchups from {issue}`392`
60+
Smaller touchups from #392
5761

5862
[`mypy --strict`]: https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict
5963

6064
### Breaking changes
6165

62-
- Deprecated individual item lookups ({issue}`390`)
66+
- Deprecated individual item lookups (#390)
6367

6468
- Removed key lookups from {meth}`libtmux.common.EnvironmentMixin.show_environment`
6569

@@ -106,17 +110,17 @@ $ pip install --user --upgrade --pre libtmux
106110
window.show_window_option('DISPLAY')
107111
```
108112

109-
- Remove `libtmux.test.retry()`, deprecated since 0.12.x ({issue}`393`)
113+
- Remove `libtmux.test.retry()`, deprecated since 0.12.x (#393)
110114

111115
### Development
112116

113-
- Fix incorrect function name `findWhere()` ({issue}`391`)
117+
- Fix incorrect function name `findWhere()` (#391)
114118

115119
## libtmux 0.12.0 (2022-07-13)
116120

117121
### Compatibility
118122

119-
- Brought back python 3.7 and 3.8 support ({issue}`375`)
123+
- Brought back python 3.7 and 3.8 support (#375)
120124
- Support for tmux 3.3a
121125

122126
- Add to CI
@@ -131,21 +135,21 @@ $ pip install --user --upgrade --pre libtmux
131135

132136
This created issues with running poetry while inside the virtualenv.
133137

134-
- Typings: Core relations, e.g. `Pane.window`, `Pane.session`, `Pane.server`, `Window.server` {issue}`385`
138+
- Typings: Core relations, e.g. `Pane.window`, `Pane.session`, `Pane.server`, `Window.server` #385
135139

136140
### Documentation
137141

138142
- Renewed logo
139-
- Try out sphinx-autoapi for its table of contents generation ({issue}`367`)
143+
- Try out sphinx-autoapi for its table of contents generation (#367)
140144
- Break up API documentations for utilities, exception, and test helpers and
141145
remove duplicate docs from API page. Server, session, window, and pane docs
142146
are in the Reference section now.
143147

144148
### Testing
145149

146-
- `retry()`: Add deprecation warning. This will be removed in 0.13.x ({issue}`368`, {issue}`372`)
147-
- New function `retry_until()`: Polls a callback function for a set period of time until it returns `True` or times out. By default it will raise {exc}`libtmux.exc.WaitTimeout`, with `raises=False` it will return `False`. Thank you @categulario! ({issue}`368`, {issue}`372`)
148-
- {issue}`384` Chore: Use absolute modules rather than root-level to avoid cyclic imports.
150+
- `retry()`: Add deprecation warning. This will be removed in 0.13.x (#368, #372)
151+
- New function `retry_until()`: Polls a callback function for a set period of time until it returns `True` or times out. By default it will raise {exc}`libtmux.exc.WaitTimeout`, with `raises=False` it will return `False`. Thank you @categulario! (#368, #372)
152+
- #384 Chore: Use absolute modules rather than root-level to avoid cyclic imports.
149153

150154
```python
151155
# Bad / Old
@@ -157,7 +161,7 @@ $ pip install --user --upgrade --pre libtmux
157161

158162
### Internals
159163

160-
- {issue}`382` [mypy] support added:
164+
- #382 [mypy] support added:
161165

162166
- Basic mypy tests now pass
163167

@@ -172,21 +176,21 @@ $ pip install --user --upgrade --pre libtmux
172176
~~Bug fixes and security updates will go to
173177
[`v0.11.x`](https://github.com/tmux-python/libtmux/tree/v0.11.x)~~
174178

175-
- Internal: Use new separator to split `tmux(1)` formatting information ({issue}`289`,
176-
{issue}`343`)
179+
- Internal: Use new separator to split `tmux(1)` formatting information (#289,
180+
#343)
177181

178182
The separator is configurable via `LIBTMUX_TMUX_FORMAT_SEPARATOR`. If you ever
179183
have compatiblity issues in the future let us know which default works best
180184
across versions.
181185

182186
Credit: @JonathanRaiman and @jagguli
183187

184-
- Basic type annotations ({issue}`359`, {issue}`361`) via @otherJL0
188+
- Basic type annotations (#359, #361) via @otherJL0
185189

186190
### Development
187191

188-
- Code cleanup ({issue}`362`) from @otherJL0
189-
- Format with black w/ string normalization. This is a one-time diff ({issue}`354`)
192+
- Code cleanup (#362) from @otherJL0
193+
- Format with black w/ string normalization. This is a one-time diff (#354)
190194

191195
### Documentation
192196

@@ -197,88 +201,88 @@ $ pip install --user --upgrade --pre libtmux
197201

198202
### Packaging
199203

200-
First experimental release using `poetry build` ({issue}`347`). If you are packaging and run
201-
across any difficulty please see {issue}`346`.
204+
First experimental release using `poetry build` (#347). If you are packaging and run
205+
across any difficulty please see #346.
202206

203207
### Compatibility
204208

205-
- Drop python 3.6 ({issue}`344`)
206-
- Add python 3.10, though still `packaging.version` issues remain ({issue}`344`)
209+
- Drop python 3.6 (#344)
210+
- Add python 3.10, though still `packaging.version` issues remain (#344)
207211

208212
A compat module and version constraints will need to be added for this
209213

210214
### Development
211215

212-
- poetry: 1.1.7 -> 1.1.12 ({issue}`344`)
213-
- Add `.pre-commit-config.yaml` ({issue}`344`)
216+
- poetry: 1.1.7 -> 1.1.12 (#344)
217+
- Add `.pre-commit-config.yaml` (#344)
214218

215219
## libtmux 0.10.2 (2021-10-30)
216220

217-
- {issue}`324`: Update poetry to 1.1
221+
- #324: Update poetry to 1.1
218222
- CI: Use poetry 1.1.7 and `install-poetry.py` installer
219223
- Relock poetry.lock at 1.1 (w/ 1.1.7's fix)
220-
- {issue}`339` (CI): Lock python at 3.9 to avoid poetry issue with `dataclasses`
221-
- ci: Fix publishing docs (similar to {issue}`339`)
222-
- {issue}`341` {issue}`342`: `Server.attached_sessions()` now supports multiple attached sessions.
224+
- #339 (CI): Lock python at 3.9 to avoid poetry issue with `dataclasses`
225+
- ci: Fix publishing docs (similar to #339)
226+
- #341 #342: `Server.attached_sessions()` now supports multiple attached sessions.
223227

224228
Remove attached sessions limitation to not detect multiple attached clients,
225229
thank you @timoses
226230

227231
## libtmux 0.10.1 (2021-06-16)
228232

229-
- Update `Window.select_window()` for {issue}`271`
233+
- Update `Window.select_window()` for #271
230234

231235
## libtmux 0.10.0 (2021-06-16)
232236

233-
- {issue}`321`: Convert to markdown
234-
- {issue}`271`: Fix {}`select_window()` by providing the session ID as
237+
- #321: Convert to markdown
238+
- #271: Fix {}`select_window()` by providing the session ID as
235239
argument to {}`-t`. Thanks @Flowdalic
236240
- Drop python 3.5 support
237241

238242
## libtmux 0.9.0 (2021-06-14)
239243

240244
Python 2.7 support dropped.
241245

242-
- {issue}`306`: chore: Remove python 2.7 support
243-
- {issue}`314`: chore: Python 3.x syntax tweaks
244-
- {issue}`312`: ci: Add tmux 3.2a to CI
246+
- #306: chore: Remove python 2.7 support
247+
- #314: chore: Python 3.x syntax tweaks
248+
- #312: ci: Add tmux 3.2a to CI
245249
- chore: Update black to [21.6b0](https://github.com/psf/black/blob/21.6b0/CHANGES.md#216b0)
246-
- {issue}`271`: Fix select_window() by providing the session ID as
250+
- #271: Fix select_window() by providing the session ID as
247251
argument to -t.
248252

249253
## libtmux 0.8.5 (2020-10-25)
250254

251-
- {issue}`297`: Enchance subprocess interaction std[in|out|err]. Needed
252-
for interact with big buffer, fixes {issue}`251`, thank you
255+
- #297: Enchance subprocess interaction std[in|out|err]. Needed
256+
for interact with big buffer, fixes #251, thank you
253257
@gil-obradors!
254-
- {issue}`303` Add `common.get_libtmux_version` which gives the tmux
258+
- #303 Add `common.get_libtmux_version` which gives the tmux
255259
version as a loose constraint. Fix linking to terms inside docs, and
256260
duplicate description of module which sphinx warned about in api.rst.
257-
- {issue}`266` Fix issue on local tests where env variables would cause
261+
- #266 Fix issue on local tests where env variables would cause
258262
show-environment to pause tests indefinitely.
259263

260264
## libtmux 0.8.4 (2020-10-25)
261265

262-
- {issue}`234`: `Window.split_window`: Allow passing `percent`, Thank
266+
- #234: `Window.split_window`: Allow passing `percent`, Thank
263267
you @jinankjain!
264-
- {issue}`289`: Fix warning due to invalid escape sequences, Thank you
268+
- #289: Fix warning due to invalid escape sequences, Thank you
265269
@tirkarthi!
266-
- {issue}`295`: Publish docs via our own action
267-
- {issue}`295`: Move more packaging over to poetry, though we'll keep
270+
- #295: Publish docs via our own action
271+
- #295: Move more packaging over to poetry, though we'll keep
268272
setup.py for the moment to ensure compatibility package maintainers.
269-
- {issue}`295`: New development instructions
270-
- {issue}`295`: Move doc/ to docs/
271-
- {issue}`296`: CI: Test python 2.7, cache python packages, prevent running
273+
- #295: New development instructions
274+
- #295: Move doc/ to docs/
275+
- #296: CI: Test python 2.7, cache python packages, prevent running
272276
internal PRs twice
273277

274278
## libtmux 0.8.3 (2020-08-16)
275279

276-
- {issue}`278`: Fix Python deprecation warnings, thanks @d1618033
280+
- #278: Fix Python deprecation warnings, thanks @d1618033
277281

278-
Also thanks Flowdalic for a similar PR at {issue}`294`
282+
Also thanks Flowdalic for a similar PR at #294
279283

280284
- Add `project_urls` to setup.py
281-
- {issue}`293` Move from Pipfile to poetry
285+
- #293 Move from Pipfile to poetry
282286
- Fix show_option test in tmux 3.0
283287
- Clean up handle_option_error comments
284288
- Move CI to a GitHub action
@@ -291,28 +295,28 @@ Python 2.7 support dropped.
291295

292296
## libtmux 0.8.1 (2019-01-26)
293297

294-
- {issue}`117` Fix issue with renaming clients with tmux 2.7 on BSD/macOS
298+
- #117 Fix issue with renaming clients with tmux 2.7 on BSD/macOS
295299
machines.
296-
- {issue}`121` Support `literal=True` (`-l`) in `Pane.send_keys`
300+
- #121 Support `literal=True` (`-l`) in `Pane.send_keys`
297301
from @ritiek
298-
- {issue}`131` Fix for unicode commands in Python 2, thanks @myw
299-
- {issue}`172` Support for next-X.Y versions from @sloria
300-
- {issue}`120` `capture_pane` support for `Pane`
301-
- {issue}`119` `display_message` support for `Pane`
302+
- #131 Fix for unicode commands in Python 2, thanks @myw
303+
- #172 Support for next-X.Y versions from @sloria
304+
- #120 `capture_pane` support for `Pane`
305+
- #119 `display_message` support for `Pane`
302306
- Sort imports with isort
303307
- Add sphinxcontrib-napoleon package for documentation
304308
- Move docstrings over to numpy's style
305309

306310
## libtmux 0.8.0 (2018-03-11)
307311

308-
- {issue}`46` Change license from BSD to MIT
312+
- #46 Change license from BSD to MIT
309313
- Move to new organization, tmux-python
310314
- Support package updates to pytest, sphinx, etc.
311315
- Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5)
312316
- Travis/CI: Update pypy veersions
313-
- {issue}`103` `Server.new_session` learned how to run commands in
317+
- #103 `Server.new_session` learned how to run commands in
314318
window on session start, thanks @grimpy!
315-
- {issue}`68` Make Server.has_session() use returncode, thanks
319+
- #68 Make Server.has_session() use returncode, thanks
316320
@jlargentaye! This should make `has_session` more robust.
317321

318322
## libtmux 0.7.8 (2018-03-04)
@@ -336,7 +340,7 @@ Python 2.7 support dropped.
336340

337341
## libtmux 0.7.4 (2017-08-19)
338342

339-
- {issue}`65` Add session id to commands, thanks [@askedrelic][@askedrelic]
343+
- #65 Add session id to commands, thanks [@askedrelic][@askedrelic]
340344

341345
## libtmux 0.7.3 (2017-05-29)
342346

@@ -348,7 +352,7 @@ Python 2.7 support dropped.
348352

349353
## libtmux 0.7.1 (2017-04-28)
350354

351-
- {issue}`37` Improve support for formatted options like
355+
- #37 Improve support for formatted options like
352356
`pane-border-status`. Thanks @kaushalmodi.
353357

354358
## libtmux 0.7.0 (2017-04-27)
@@ -383,23 +387,23 @@ Python 2.7 support dropped.
383387

384388
## libtmux 0.6.4 (2017-03-25)
385389

386-
- {issue}`32` support for OpenBSD's tmux
390+
- #32 support for OpenBSD's tmux
387391

388392
## libtmux 0.6.3 (2017-02-08)
389393

390-
- {issue}`25` support for working with tmux `master`, thanks @sloria.
394+
- #25 support for working with tmux `master`, thanks @sloria.
391395

392396
## libtmux 0.6.2 (2017-01-19)
393397

394-
- {issue}`197` use {}`LooseVersion` instead of {}`StrictVersion` for version
398+
- #197 use {}`LooseVersion` instead of {}`StrictVersion` for version
395399
checks. Thanks @minijackson.
396400
- Pin packages with pyup.io
397-
- {issue}`21` Readme fix from @huwenchao.
401+
- #21 Readme fix from @huwenchao.
398402

399403
## libtmux 0.6.1 (2016-12-20)
400404

401-
- {issue}`18` Fix logger, courtesy of @geekli
402-
- {issue}`19` Add support for `start_directory` in new sessions and
405+
- #18 Fix logger, courtesy of @geekli
406+
- #19 Add support for `start_directory` in new sessions and
403407
panes, courtesy of @gandelman-a.
404408
- Fix tests and add official support for 2.3
405409

@@ -412,14 +416,14 @@ Python 2.7 support dropped.
412416

413417
## libtmux 0.5.1 (2016-08-18)
414418

415-
- {issue}`12` - fix logger message when tmux doesn't exist in `PATH`
419+
- #12 - fix logger message when tmux doesn't exist in `PATH`
416420

417421
## libtmux 0.5 (2016-06-15)
418422

419-
- {issue}`8` new exception `UnknownOption`
420-
- {issue}`8` return `None` for options that are valid tmux options,
423+
- #8 new exception `UnknownOption`
424+
- #8 return `None` for options that are valid tmux options,
421425
but unset at that scope.
422-
- {issue}`6` major documentation overhaul
426+
- #6 major documentation overhaul
423427

424428
## libtmux 0.4.1 (2016-05-23)
425429

0 commit comments

Comments
 (0)