Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
gvalkov committed Feb 18, 2024
1 parent 0593dd4 commit b613af4
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 19 deletions.
22 changes: 17 additions & 5 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
Changelog
---------

1.7.0 (Feb 18, 2024)
====================

- Respect the ``CPATH/C_INCLUDE_PATH`` environment variables during install.

- Add the uniq address to the string representation of ``InputDevice``.

- Improved method for finding the device node corresponding to a uinput device (`#206 https://github.com/gvalkov/python-evdev/pull/206`_).

- Repository TLC (reformatted with ruff, fixed linting warnings, moved packaging metadata to ``pyproject.toml`` etc.).


1.6.1 (Jan 20, 2023)
==================
====================

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


1.6.0 (Jul 17, 2022)
==================
====================

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


1.5.0 (Mar 24, 2022)
==================
====================

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

Expand Down
7 changes: 2 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinx_copybutton",
]

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

if not on_rtd:
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
18 changes: 9 additions & 9 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Python-evdev has been packaged for the following GNU/Linux distributions:
<a href="https://packages.ubuntu.com/search?suite=default&section=all&arch=any&keywords=python-evdev&searchon=names">
<img height="30px" src="_static/pacifica-icon-set/distributor-logo-ubuntu.png">
</a>
<a href="https://apps.fedoraproject.org/packages/python3-evdev">
<a href="https://packages.fedoraproject.org/pkgs/python-evdev/python3-evdev/">
<img height="30px" src="_static/pacifica-icon-set/distributor-logo-fedora.png">
</a>
<!--
Expand All @@ -34,23 +34,23 @@ From source
===========
The latest stable version of *python-evdev* can be installed from pypi_,
provided that you have gcc/clang, pip_ and the Python and Linux development
headers installed on your system. Installing them is distribution specific and
typically falls in one of the following categories:
provided that you have a compiler, pip_ and the Python and Linux development
headers installed on your system. Installing these is distribution specific and
typically falls in one of the following:
On a Debian compatible OS:
.. code-block:: bash
$ apt-get install python-dev python-pip gcc
$ apt-get install linux-headers-$(uname -r)
$ apt install python-dev python-pip gcc
$ apt install linux-headers-$(uname -r)
On a Redhat compatible OS:
.. code-block:: bash
$ yum install python-devel python-pip gcc
$ yum install kernel-headers-$(uname -r)
$ dnf install python-devel python-pip gcc
$ dnf install kernel-headers-$(uname -r)
On Arch Linux and derivatives:
Expand All @@ -73,7 +73,7 @@ By default, the setup script will look for the ``input.h`` and
``input-event-codes.h`` [#f1]_ header files ``/usr/include/linux``.
You may use the ``--evdev-headers`` option to the ``build_ext`` setuptools
command to specify the location of these header files. It accepts one or more
command to the location of these header files. It accepts one or more
colon-separated paths. For example:
.. code-block:: bash
Expand Down

0 comments on commit b613af4

Please sign in to comment.