Skip to content

Commit b613af4

Browse files
committed
Documentation fixes
1 parent 0593dd4 commit b613af4

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

docs/changelog.rst

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
11
Changelog
22
---------
33

4+
1.7.0 (Feb 18, 2024)
5+
====================
6+
7+
- Respect the ``CPATH/C_INCLUDE_PATH`` environment variables during install.
8+
9+
- Add the uniq address to the string representation of ``InputDevice``.
10+
11+
- Improved method for finding the device node corresponding to a uinput device (`#206 https://github.com/gvalkov/python-evdev/pull/206`_).
12+
13+
- Repository TLC (reformatted with ruff, fixed linting warnings, moved packaging metadata to ``pyproject.toml`` etc.).
14+
15+
416
1.6.1 (Jan 20, 2023)
5-
==================
17+
====================
618

7-
- Fix generation of ``ecodes.c`` when the path to ````sys.executable`` contains spaces.
19+
- Fix generation of ``ecodes.c`` when the path to ``sys.executable`` contains spaces.
820

921

1022
1.6.0 (Jul 17, 2022)
11-
==================
23+
====================
1224

13-
- Fix Python 3.11 compatibility (`#174 <https://github.com/gvalkov/python-evdev/pull/174>`_)
25+
- Fix Python 3.11 compatibility (`#174 <https://github.com/gvalkov/python-evdev/pull/174>`_).
1426

1527

1628
1.5.0 (Mar 24, 2022)
17-
==================
29+
====================
1830

1931
- Fix documentation (`#163 <https://github.com/gvalkov/python-evdev/pull/163>`_, `#160 <https://github.com/gvalkov/python-evdev/pull/160>`_).
2032

docs/conf.py

+2-5
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"sphinx.ext.viewcode",
4141
"sphinx.ext.intersphinx",
4242
"sphinx.ext.napoleon",
43+
"sphinx_rtd_theme",
4344
"sphinx_copybutton",
4445
]
4546

@@ -111,11 +112,7 @@
111112
# The theme to use for HTML and HTML Help pages. See the documentation for
112113
# a list of builtin themes.
113114

114-
if not on_rtd:
115-
import sphinx_rtd_theme
116-
117-
html_theme = "sphinx_rtd_theme"
118-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
115+
html_theme = "sphinx_rtd_theme"
119116

120117
# Theme options are theme-specific and customize the look and feel of a theme
121118
# further. For a list of options available for each theme, see the

docs/install.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Python-evdev has been packaged for the following GNU/Linux distributions:
1616
<a href="https://packages.ubuntu.com/search?suite=default&section=all&arch=any&keywords=python-evdev&searchon=names">
1717
<img height="30px" src="_static/pacifica-icon-set/distributor-logo-ubuntu.png">
1818
</a>
19-
<a href="https://apps.fedoraproject.org/packages/python3-evdev">
19+
<a href="https://packages.fedoraproject.org/pkgs/python-evdev/python3-evdev/">
2020
<img height="30px" src="_static/pacifica-icon-set/distributor-logo-fedora.png">
2121
</a>
2222
<!--
@@ -34,23 +34,23 @@ From source
3434
===========
3535
3636
The latest stable version of *python-evdev* can be installed from pypi_,
37-
provided that you have gcc/clang, pip_ and the Python and Linux development
38-
headers installed on your system. Installing them is distribution specific and
39-
typically falls in one of the following categories:
37+
provided that you have a compiler, pip_ and the Python and Linux development
38+
headers installed on your system. Installing these is distribution specific and
39+
typically falls in one of the following:
4040
4141
On a Debian compatible OS:
4242
4343
.. code-block:: bash
4444
45-
$ apt-get install python-dev python-pip gcc
46-
$ apt-get install linux-headers-$(uname -r)
45+
$ apt install python-dev python-pip gcc
46+
$ apt install linux-headers-$(uname -r)
4747
4848
On a Redhat compatible OS:
4949
5050
.. code-block:: bash
5151
52-
$ yum install python-devel python-pip gcc
53-
$ yum install kernel-headers-$(uname -r)
52+
$ dnf install python-devel python-pip gcc
53+
$ dnf install kernel-headers-$(uname -r)
5454
5555
On Arch Linux and derivatives:
5656
@@ -73,7 +73,7 @@ By default, the setup script will look for the ``input.h`` and
7373
``input-event-codes.h`` [#f1]_ header files ``/usr/include/linux``.
7474
7575
You may use the ``--evdev-headers`` option to the ``build_ext`` setuptools
76-
command to specify the location of these header files. It accepts one or more
76+
command to the location of these header files. It accepts one or more
7777
colon-separated paths. For example:
7878
7979
.. code-block:: bash

0 commit comments

Comments
 (0)