Skip to content

Commit 318521d

Browse files
committed
docs: tweak
1 parent 712503a commit 318521d

File tree

8 files changed

+20
-4
lines changed

8 files changed

+20
-4
lines changed

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
cache: pip
4141
- name: Install dependencies
4242
run: |
43-
python -m pip install -U pip
43+
python -m pip install -U pip
4444
python -m pip install -e '.[docs]'
4545
- name: Build
4646
run: |

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
See Git checking messages for full history.
44

5-
## 10.1.1.dev0 (2025-xx-xx)
5+
## 10.2.0.dev0 (2025-xx-xx)
66
- Linux: check the server for Xrandr support version (#417)
77
- Linux: improve typing and error messages for X libraries (#418)
88
- Linux: introduce an XCB-powered backend stack with a factory in ``mss.linux`` while keeping the Xlib code as a fallback (#425)

docs/source/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,20 @@ Factory function to return the appropriate backend implementation.
5151
- "xgetimage": XCB-based backend using XGetImage
5252
- "xlib": Traditional Xlib-based backend retained for environments without working XCB libraries
5353

54+
.. versionadded:: 10.2.0
55+
The :py:attr:`backend` attribute.
56+
5457
.. function:: MSS(*args, **kwargs)
5558

5659
Alias for :func:`mss` for backward compatibility.
5760

61+
.. versionadded:: 10.2.0
62+
5863

5964
Xlib Backend
6065
^^^^^^^^^^^^
6166

67+
.. versionadded:: 10.2.0
6268
.. module:: mss.linux.xlib
6369

6470
Legacy Xlib-based backend, kept as a fallback when XCB is unavailable.
@@ -113,6 +119,7 @@ Legacy Xlib-based backend, kept as a fallback when XCB is unavailable.
113119
XGetImage Backend
114120
^^^^^^^^^^^^^^^^^
115121

122+
.. versionadded:: 10.2.0
116123
.. module:: mss.linux.xgetimage
117124

118125
XCB-based backend using XGetImage protocol.
@@ -125,6 +132,7 @@ XCB-based backend using XGetImage protocol.
125132
XShmGetImage Backend
126133
^^^^^^^^^^^^^^^^^^^^
127134

135+
.. versionadded:: 10.2.0
128136
.. module:: mss.linux.xshmgetimage
129137

130138
XCB-based backend using XShmGetImage protocol with shared memory.

docs/source/developers.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ To build the documentation, simply type::
5555
XCB Code Generator
5656
==================
5757

58+
.. versionadded:: 10.2.0
59+
5860
The GNU/Linux XCB backends rely on generated ctypes bindings. If you need to
5961
add new XCB requests or types, do **not** edit ``src/mss/linux/xcbgen.py`` by
6062
hand. Instead, follow the workflow described in ``src/xcbproto/README.md``,

docs/source/examples.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ falling back to XGetImage:
112112
.. literalinclude:: examples/linux_xshm_backend.py
113113
:lines: 7-
114114

115+
.. versionadded:: 10.2.0
116+
115117
PIL
116118
===
117119

docs/source/usage.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Backends
6161

6262
Some platforms have multiple ways to take screenshots. In MSS, these are known as *backends*. The :py:func:`mss` functions will normally autodetect which one is appropriate for your situation, but you can override this if you want. For instance, you may know that your specific situation requires a particular backend.
6363

64-
If you want to choose a particular backend, you can use the :py::`backend` keyword to :py:func:`mss`::
64+
If you want to choose a particular backend, you can use the :py:attr:`backend` keyword to :py:func:`mss`::
6565

6666
with mss(backend="xgetimage") as sct:
6767
...
@@ -140,3 +140,6 @@ Or via direct call from Python::
140140

141141
.. versionadded:: 8.0.0
142142
``--with-cursor`` to include the cursor in screenshots.
143+
144+
.. versionadded:: 10.2.0
145+
``--backend`` to force selecting the backend to use.

docs/source/where.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Who Uses it?
55
This is a non exhaustive list where MSS is integrated or has inspired.
66
Do not hesitate to `say Hello! <https://github.com/BoboTiG/python-mss/issues>`_ if you are using MSS too.
77

8+
- Nvidia;
89
- `Airtest <https://github.com/AirtestProject/Airtest>`_, a cross-platform UI automation framework for aames and apps;
910
- `Automation Framework <https://github.com/capaximperii/AutomationFramework>`_, a Batmans utility;
1011
- `DeepEye <https://github.com/thayerAlshaabi/DeepEye>`_, a deep vision-based software library for autonomous and advanced driver-assistance systems;

src/mss/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from mss.exception import ScreenShotError
1212
from mss.factory import mss
1313

14-
__version__ = "10.1.1.dev0"
14+
__version__ = "10.2.0.dev0"
1515
__author__ = "Mickaël Schoentgen"
1616
__date__ = "2013-2025"
1717
__copyright__ = f"""

0 commit comments

Comments
 (0)