Merge pull request #690 from javiereguiluz/more_doc_fixes

Fixed doc errors reported by docs build tool
liip · Jan 9, 2016 · bf3f931 · bf3f931
2 parents f5341df + 58c384b
commit bf3f931
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 20 deletions.
diff --git a/Resources/doc/cache-resolvers.rst b/Resources/doc/cache-resolvers.rst
@@ -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
 -----------------------------------

diff --git a/Resources/doc/configuration.rst b/Resources/doc/configuration.rst
@@ -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

diff --git a/Resources/doc/data-loaders.rst b/Resources/doc/data-loaders.rst
@@ -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
 ------------------

diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst
@@ -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