From a3aafcd7f572ee56c8b43e2d1d60cd252483a02f Mon Sep 17 00:00:00 2001 From: alvy Date: Wed, 7 Oct 2020 17:43:14 -0400 Subject: [PATCH 1/3] add a paragraph in index to linkt build_meta doc --- docs/userguide/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index abee331a2f..8470e268d8 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -10,6 +10,15 @@ packages. Packages built and distributed using ``setuptools`` look to the user like ordinary Python packages based on the ``distutils``. +Transition to PEP517 +==================== + +Since setuptools no longer serves as the default build tool, one must explicitly +opt in (by providing a ``pyproject.toml`` file) to use this library. The user +facing part is provided by `PEP517 `_ and +backend interface is described :ref:`in this document <../build_meta>`. The +quickstart provides an overview of the new workflow. + .. toctree:: :maxdepth: 1 From f04cd3b21f1bd8ef5c8dedc42fb8708dfdf0fccd Mon Sep 17 00:00:00 2001 From: alvy Date: Mon, 12 Oct 2020 19:23:00 -0400 Subject: [PATCH 2/3] make suggested edits --- docs/userguide/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 8470e268d8..7abc7903fc 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -14,8 +14,8 @@ Transition to PEP517 ==================== Since setuptools no longer serves as the default build tool, one must explicitly -opt in (by providing a ``pyproject.toml`` file) to use this library. The user -facing part is provided by `PEP517 `_ and +opt in (by providing a :file:`pyproject.toml` file) to use this library. The user +facing part is provided by tools such as pip and backend interface is described :ref:`in this document <../build_meta>`. The quickstart provides an overview of the new workflow. From 23f874ca386f8f33beae3e287b866af79f97415f Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 17 Oct 2020 11:56:01 -0400 Subject: [PATCH 3/3] Prefer doc role to ref role. Co-authored-by: Sviatoslav Sydorenko --- docs/userguide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 7abc7903fc..18679c5486 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -16,7 +16,7 @@ Transition to PEP517 Since setuptools no longer serves as the default build tool, one must explicitly opt in (by providing a :file:`pyproject.toml` file) to use this library. The user facing part is provided by tools such as pip and -backend interface is described :ref:`in this document <../build_meta>`. The +backend interface is described :doc:`in this document <../build_meta>`. The quickstart provides an overview of the new workflow. .. toctree::