Hopiu/django-imagekit
1
0
Fork 0
mirror of https://github.com/Hopiu/django-imagekit.git synced 2026-03-16 21:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #496 from nthall/documentation-links

Browse source 
fix broken links in documentation (#319)
This commit is contained in:
Venelin Stoykov 2020-02-21 23:34:17 +02:00 committed by GitHub
commit bc12a319b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.rst
View file

@ -39,6 +39,7 @@ Installation
Usage Overview
==============
.. _specs:
Specs
-----

6
docs/caching.rst
View file

@ -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
------------------

13
docs/upgrading.rst
View file

@ -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 <cache-file-backend>` and :ref:`cache file strategies <cache-file-strategy>`
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 <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