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

Fixed doc errors reported by docs build tool #690

Merged
merged 2 commits into from
Jan 9, 2016
Merged

Fixed doc errors reported by docs build tool #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e47441f
Fixed doc errors reported by docs build tool
javiereguiluz Jan 8, 2016
58c384b
Reverted some changes fixed in a different PR
javiereguiluz Jan 8, 2016
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
13 changes: 8 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,14 @@
Built-In CacheResolver
======================

* :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>`
.. toctree::
:maxdepth: 1

cache-resolver/web_path
cache-resolver/amazons3
cache-resolver/aws_s3
cache-resolver/cache
cache-resolver/proxy

Changing the default cache resolver
-----------------------------------
Expand Down
9 changes: 6 additions & 3 deletions Resources/doc/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,12 @@ Each filter set that you specify has the following options:
* ``post_processors`` - sets post-processors to be applied on filtered image
(see Post-Processors section in the :doc:`filters chapter <filters>` for details).
* ``quality`` - override the default quality of 100 for the generated images. **(deprecated)**
* ``jpeg_quality`` - override the quality for jpeg images (this overrides the ``quality`` option above)
* ``png_compression_level`` - set the compression level for png images (0-9) (this overrides the ``quality`` option above)
* ``png_compression_filter`` - set the compression filter for png images (see the ``filters`` parameter for ``imagepng`` function in `PHP manual`_ for more details)
* ``jpeg_quality`` - override the quality for jpeg images (this overrides the
``quality`` option above)
* ``png_compression_level`` - set the compression level for png images (0-9)
(this overrides the ``quality`` option above)
* ``png_compression_filter`` - set the compression filter for png images (see the
``filters`` parameter for ``imagepng`` function in `PHP manual`_ for more details)
* ``cache`` - override the default cache setting.
* ``data_loader`` - override the default data loader.
* ``route`` - optional list of route requirements, defaults and options using in
Expand Down
9 changes: 6 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,12 @@
Built-In DataLoader
===================

* :doc:`FileSystem <data-loader/filesystem>`
* :doc:`MongoDB GridFS <data-loader/gridfs>`
* :doc:`Stream <data-loader/stream>`
.. toctree::
:maxdepth: 1

data-loader/filesystem
data-loader/gridfs
data-loader/stream

Other data loaders
------------------
Expand Down
20 changes: 11 additions & 9 deletions Resources/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ This bundle allows to alter images in certain ways, such as scaling or rotating
them, creating thumbnails, adding watermarks, etc. In order to not hurt application
performance, altered images can be cached locally and in Amazon S3 service.

* :doc:`Installation <installation>`
* :doc:`Introduction <introduction>`
* :doc:`Basic usage <basic-usage>`
* :doc:`Configuration <configuration>`
* :doc:`Filters <filters>`
* :doc:`DataLoaders <data-loaders>`
* :doc:`CacheResolvers <cache-resolvers>`
* :doc:`CacheManager <cache-manager>`
* :doc:`Commands <commands>`
.. toctree::
:maxdepth: 1

installation
introduction
basic-usage
configuration
data-loaders
cache-resolvers
cache-manager
commands