diff --git a/changelog/10721.doc.rst b/changelog/10721.doc.rst new file mode 100644 index 00000000000..8b8fecf1546 --- /dev/null +++ b/changelog/10721.doc.rst @@ -0,0 +1 @@ +Document PEP 621 ``pyproject.toml`` entry point format for ``pytest11`` plugins in plugin writing guide. diff --git a/changelog/14823.doc.rst b/changelog/14823.doc.rst new file mode 100644 index 00000000000..66d9dc63185 --- /dev/null +++ b/changelog/14823.doc.rst @@ -0,0 +1 @@ +Fix unresolved Sphinx cross-reference for ``package_env`` in changelog documentation. diff --git a/doc/en/changelog.rst b/doc/en/changelog.rst index c5601712b00..8ecdf31d116 100644 --- a/doc/en/changelog.rst +++ b/doc/en/changelog.rst @@ -466,7 +466,7 @@ Packaging updates and notes for downstreams ------------------------------------------- - `#13933 `_: The tox configuration has been adjusted to make sure the desired - version string can be passed into its :ref:`package_env` through + version string can be passed into its `package_env `_ through the ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` environment variable as a part of the release process -- by :user:`webknjaz`. @@ -481,7 +481,7 @@ Contributor-facing changes - `#13933 `_: The tox configuration has been adjusted to make sure the desired - version string can be passed into its :ref:`package_env` through + version string can be passed into its `package_env `_ through the ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` environment variable as a part of the release process -- by :user:`webknjaz`. diff --git a/doc/en/how-to/writing_plugins.rst b/doc/en/how-to/writing_plugins.rst index 17823098d0c..55df2e270f5 100644 --- a/doc/en/how-to/writing_plugins.rst +++ b/doc/en/how-to/writing_plugins.rst @@ -215,7 +215,14 @@ as plugins. As an example consider the following package:: pytest_foo/plugin.py pytest_foo/helper.py -With the following typical ``setup.py`` extract: +With the following typical ``pyproject.toml`` extract: + +.. code-block:: toml + + [project.entry-points.pytest11] + foo = "pytest_foo.plugin" + +Or with a legacy ``setup.py`` extract: .. code-block:: python