Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed the syntax of the internal doc links #554

Merged
merged 1 commit into from
Jan 16, 2015
Merged

Fixed the syntax of the internal doc links #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Resources/doc/cache-resolver/aws_s3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ names and create additional services!
Additional options
------------------

You can use `Cache <cache>`_ and `Proxy <proxy>`_ resolvers in chain with
You can use :doc:`Cache <cache>` and :doc:`Proxy <proxy>` resolvers in chain with
current. You just need to configure them with defined options.

.. code-block:: yaml
Expand All @@ -98,8 +98,8 @@ current. You just need to configure them with defined options.
proxies: ['http://one.domain.com', 'http://two.domain.com']
cache: true

If enabled both first one will be `Cache <cache>`_, then `Proxy <proxy>`_ and
after all process delegates to AwsS3 resolver.
If enabled both first one will be :doc:`Cache <cache>`, then :doc:`Proxy <proxy>`
and after all process delegates to AwsS3 resolver.

Object GET Options
------------------
Expand Down
10 changes: 5 additions & 5 deletions Resources/doc/cache-resolvers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Built-In CacheResolver
======================

* `Web path <cache-resolver/web_path>`_
* `AmazonS3 <cache-resolver/amazons3>`_
* `AwsS3 <cache-resolver/aws_s3>`_ - for SDK version
* `CacheResolver <cache-resolver/cache>`_
* `ProxyResolver <cache-resolver/proxy>`_
* :doc:`Web path <cache-resolver/web_path>`
* :doc:`AmazonS3 <cache-resolver/amazons3>`
* :doc:`AwsS3 <cache-resolver/aws_s3>` - for SDK version
* :doc:`CacheResolver <cache-resolver/cache>`
* :doc:`ProxyResolver <cache-resolver/proxy>`

Changing the default cache resolver
-----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Each filter set that you specify has the following options:
* ``filters`` - determine the type of filter to be used (refer to *Filters* section
for more information) and options that should be passed to the specific filter type.
* ``post_processors`` - sets post-processors to be applied on filtered image
(see Post-Processors section in the `filters chapter <filters>`_ for details).
(see Post-Processors section in the :doc:`filters chapter <filters>` for details).
* ``quality`` - override the default quality of 100 for the generated images.
* ``cache`` - override the default cache setting.
* ``data_loader`` - override the default data loader.
Expand Down
6 changes: 3 additions & 3 deletions Resources/doc/data-loaders.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Built-In DataLoader
===================

* :doc:`FileSystem <data-loader/filesystem>`_
* :doc:`MongoDB GridFS <data-loader/gridfs>`_
* :doc:`Stream <data-loader/stream>`_
* :doc:`FileSystem <data-loader/filesystem>`
* :doc:`MongoDB GridFS <data-loader/gridfs>`
* :doc:`Stream <data-loader/stream>`

Other data loaders
------------------
Expand Down
14 changes: 7 additions & 7 deletions Resources/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
LiipImagineBundle
=================

* :doc:`Installation <installation>`_
* :doc:`Introduction <introduction>`_
* :doc:`Configuration <configuration>`_
* :doc:`Filters <filters>`_
* :doc:`DataLoaders <data-loaders>`_
* :doc:`CacheResolvers <cache-resolvers>`_
* :doc:`CacheManager <cache-manager>`_
* :doc:`Installation <installation>`
* :doc:`Introduction <introduction>`
* :doc:`Configuration <configuration>`
* :doc:`Filters <filters>`
* :doc:`DataLoaders <data-loaders>`
* :doc:`CacheResolvers <cache-resolvers>`
* :doc:`CacheManager <cache-manager>`
6 changes: 3 additions & 3 deletions Resources/doc/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The most important parts about those ``DataLoader``:
1. They ``find`` a single image based on a given identifier.
2. They return a ready-to-use ``Imagine\Image\ImageInterface``.

Check out the `chapter about data loaders <data-loaders>`_ to learn more about them.
Check out the :doc:`chapter about data loaders <data-loaders>` to learn more about them.

Apply filters on the original image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -49,7 +49,7 @@ The filter has one objective: Apply itself on the provided image (loaded by the
``DataLoader``). It receives options to configure the actual result of it, to
customize the outcome.

Check out the `chapter about filters <filters>`_ to learn more about them.
Check out the :doc:`chapter about filters <filters>` to learn more about them.

Cache the filtered image
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -81,4 +81,4 @@ The responsibilities of the ``CacheResolver`` are:
3. generate an URI to address the cached image directly,
4. remove a cached image.

Check out the `chapter about cache resolvers <cache-resolvers>`_ to learn more about them.
Check out the :doc:`chapter about cache resolvers <cache-resolvers>` to learn more about them.