From f42783143ccf803987e2ee82ee3ba12a26a31e01 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Sat, 10 Apr 2021 10:23:44 +0200 Subject: Fixed quickstart packaging resources hyperlink. The implicit link target that should have been created from the title was not being detected correctly. This was causing the link to be interpreted as an external hyperlink reference, resulting in a 404 in the rendered docs. Adding the explicit target and `ref` allows the link to resolve correctly. --- docs/userguide/quickstart.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 2807f59b..53810526 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -22,7 +22,7 @@ be generated with whatever tools that provides a ``build sdist``-alike functionality. While this may appear cumbersome, given the added pieces, it in fact tremendously enhances the portability of your package. The change is driven under :pep:`PEP 517 <517#build-requirements>`. To learn more about Python packaging in general, -navigate to the `bottom `_ of this page. +navigate to the :ref:`bottom ` of this page. Basic Use @@ -215,13 +215,14 @@ basic use here. Transitioning from ``setup.py`` to ``setup.cfg`` -================================================== +================================================ To avoid executing arbitary scripts and boilerplate code, we are transitioning into a full-fledged ``setup.cfg`` to declare your package information instead of running ``setup()``. This inevitably brings challenges due to a different syntax. Here we provide a quick guide to understanding how ``setup.cfg`` is parsed by ``setuptool`` to ease the pain of transition. +.. _packaging-resources: Resources on Python packaging ============================= -- cgit v1.2.1