Skip to content

Commit 1a4b57d

Browse files
committed
Update README
1 parent f18fa79 commit 1a4b57d

File tree

2 files changed

+11
-18
lines changed

2 files changed

+11
-18
lines changed

README.rst

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,14 @@ Python C API compatibility
66
:alt: Build status of pythoncapi_compat on GitHub Actions
77
:target: https://github.com/pythoncapi/pythoncapi_compat/actions
88

9-
The Python C API compatibility project is made of two parts:
9+
The ``pythoncapi_compat`` project can be used to write a C extension supporting
10+
a wide range of Python versions with a single code base. It is made of the
11+
``pythoncapi_compat.h`` header file and the ``upgrade_pythoncapi.py`` script.
1012

11-
* ``pythoncapi_compat.h``: Header file providing new functions of the Python C
12-
API to old Python versions.
13-
* ``upgrade_pythoncapi.py``: Script upgrading C extension modules to newer
14-
Python API without losing support for old Python versions. It relies on
15-
``pythoncapi_compat.h``.
16-
17-
Homepage:
18-
https://github.com/pythoncapi/pythoncapi_compat
19-
20-
Latest header file:
21-
https://raw.githubusercontent.com/pythoncapi/pythoncapi_compat/master/pythoncapi_compat.h
13+
* Homepage: `GitHub pythoncapi_compat project
14+
<https://github.com/pythoncapi/pythoncapi_compat>`_.
15+
* `Documentation
16+
<https://pythoncapi-compat.readthedocs.io/en/latest/>`_
2217

2318
This project is distributed under the MIT license and is covered by the `PSF
2419
Code of Conduct <https://www.python.org/psf/codeofconduct/>`_.

docs/index.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
Python C API compatibility
33
++++++++++++++++++++++++++
44

5-
.. image:: https://github.com/pythoncapi/pythoncapi_compat/actions/workflows/build.yml/badge.svg
6-
:alt: Build status of pythoncapi_compat on GitHub Actions
7-
:target: https://github.com/pythoncapi/pythoncapi_compat/actions
8-
95
The ``pythoncapi_compat`` project can be used to write a C extension supporting
106
a wide range of Python versions with a single code base. It is made of the
117
``pythoncapi_compat.h`` header file and the ``upgrade_pythoncapi.py`` script.
128

13-
Homepage: `GitHub pythoncapi_compat project
14-
<https://github.com/pythoncapi/pythoncapi_compat>`_.
9+
* Homepage: `GitHub pythoncapi_compat project
10+
<https://github.com/pythoncapi/pythoncapi_compat>`_.
11+
* `Documentation
12+
<https://pythoncapi-compat.readthedocs.io/en/latest/>`_
1513

1614
Documentation:
1715

0 commit comments

Comments
 (0)