From 85f0741594dbcf5d74dbee5d1b28c94d333792b1 Mon Sep 17 00:00:00 2001 From: Noah Hall Date: Thu, 20 Feb 2020 22:25:29 -0500 Subject: [PATCH] fix broken links in documentation (#319) --- README.rst | 1 + docs/caching.rst | 6 +++++- docs/upgrading.rst | 13 +++---------- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index d797561..a1fab51 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,7 @@ Installation Usage Overview ============== +.. _specs: Specs ----- diff --git a/docs/caching.rst b/docs/caching.rst index 8264089..6b576fc 100644 --- a/docs/caching.rst +++ b/docs/caching.rst @@ -3,7 +3,7 @@ Caching Default Backend Workflow -================ +======================== ``ImageSpec`` @@ -29,6 +29,8 @@ objects, but they've got a little trick up their sleeve: they represent files that may not actually exist! +.. _cache-file-strategy: + Cache File Strategy ------------------- @@ -55,6 +57,8 @@ The default strategy only defines the first two of these, as follows: file.generate() +.. _cache-file-backend: + Cache File Backend ------------------ diff --git a/docs/upgrading.rst b/docs/upgrading.rst index 2a48a75..15eab6d 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -79,12 +79,9 @@ IK3 provides analogous settings for cache file backends and strategies: IMAGEKIT_DEFAULT_CACHEFILE_BACKEND = 'path.to.MyCacheFileBackend' IMAGEKIT_DEFAULT_CACHEFILE_STRATEGY = 'path.to.MyCacheFileStrategy' -See the documentation on `cache file backends`_ and `cache file strategies`_ +See the documentation on :ref:`cache file backends ` and :ref:`cache file strategies ` for more details. -.. _`cache file backends`: -.. _`cache file strategies`: - Conditional model ``processors`` -------------------------------- @@ -93,9 +90,7 @@ In IK2, an ``ImageSpecField`` could take a ``processors`` callable instead of an iterable, which allowed processing decisions to made based on other properties of the model. IK3 does away with this feature for consistency's sake (if one kwarg could be callable, why not all?), but provides a much more robust -solution: the custom ``spec``. See the `advanced usage`_ documentation for more. - -.. _`advanced usage`: +solution: the custom ``spec``. See the :doc:`advanced usage ` documentation for more. Conditonal ``cache_to`` file names @@ -109,9 +104,7 @@ There is a way to achieve custom file names by overriding your spec's ``cachefile_name``, but it is not recommended, as the spec's default behavior is to hash the combination of ``source``, ``processors``, ``format``, and other spec options to ensure that changes to the spec always result in -unique file names. See the documentation on `specs`_ for more. - -.. _`specs`: +unique file names. See the documentation on :ref:`specs` for more. Processors have moved to PILKit