From b37747b1c0a601520bf0c95f8e3936f3a7a19ecd Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Tue, 1 Feb 2022 12:44:26 +0000 Subject: [PATCH] Add news fragment --- changelog.d/3068.change.rst | 13 +++++++++++++ changelog.d/3068.deprecation.rst | 8 ++++++++ docs/conf.py | 8 +++++++- 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 changelog.d/3068.change.rst create mode 100644 changelog.d/3068.deprecation.rst diff --git a/changelog.d/3068.change.rst b/changelog.d/3068.change.rst new file mode 100644 index 0000000000..ca71972b3c --- /dev/null +++ b/changelog.d/3068.change.rst @@ -0,0 +1,13 @@ +Added **experimental** support for ``pyproject.toml`` configuration +(as introduced by :pep:`621`). Configuration parameters not covered by +standards are handled in the ``[tool.setuptools]`` sub-table. + +In the future, existing ``setup.cfg`` configuration +may be automatically converted into the ``pyproject.toml`` equivalent before taking effect +(as proposed in :issue:`1688`). Meanwhile users can use automated tools like +:pypi:`ini2toml` to help in the transition. + +Please note that the legacy backend is not guaranteed to work with +``pyproject.toml`` configuration. + +-- by :user:`abravalheri` diff --git a/changelog.d/3068.deprecation.rst b/changelog.d/3068.deprecation.rst new file mode 100644 index 0000000000..3bae915c08 --- /dev/null +++ b/changelog.d/3068.deprecation.rst @@ -0,0 +1,8 @@ +Deprecated ``setuptools.config.read_configuration``, +``setuptools.config.parse_configuration`` and other functions or classes +from ``setuptools.config``. + +Users that still need to parse and process configuration from ``setup.cfg`` can +import a direct replacement from ``setuptools.config.setupcfg``, however this +module is transitional and might be removed in the future +(the ``setup.cfg`` configuration format itself is likely to be deprecated in the future). diff --git a/docs/conf.py b/docs/conf.py index bfd45a69d2..187fc65c48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,10 +93,16 @@ # Add support for linking usernames github_url = 'https://github.com' +github_repo_org = 'pypa' +github_repo_name = 'setuptools' +github_repo_slug = f'{github_repo_org}/{github_repo_name}' +github_repo_url = f'{github_url}/{github_repo_slug}' github_sponsors_url = f'{github_url}/sponsors' extlinks = { + 'issue': (f'{github_repo_url}/issues/%s', 'issue #%s'), # noqa: WPS323 + 'pr': (f'{github_repo_url}/pull/%s', 'PR #%s'), # noqa: WPS323 'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323 - 'pypi': ('https://pypi.org/project/%s', '%s'), + 'pypi': ('https://pypi.org/project/%s', '%s'), # noqa: WPS323 } extensions += ['sphinx.ext.extlinks']