Added spell checker

- Added spell checker target using sphinxcontrib-spelling

Author: dantleech

.travis.yml

@@ -3,6 +3,11 @@ language: python
 python:
     - "2.7"
 
+before_script:
+    - sudo apt-get install enchant
+
 install: "pip install -q -r requirements.txt --use-mirrors"
 
-script: sphinx-build -nW -b html -d _build/doctrees . _build/html
+script: 
+    - sphinx-build -nW -b html -d _build/doctrees . _build/html
+    - make spelling

Makefile

@@ -37,6 +37,7 @@ help:
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  spelling   generate a spelling report"
 
 clean:
 	-rm -rf $(BUILDDIR)/*
@@ -151,3 +152,7 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo "Spelling report generated in $(BUILDDIR)/spelling/output.txt"

book/database_layer.rst

@@ -171,7 +171,7 @@ After this, you have to create getters and setters for the properties.
     This Document uses the parent document and a node name to determine its
     position in the tree. Because there isn't any name set, it is generated
     automatically. If you want to use a specific node name, such as a
-    sluggified version of the title, you need to add a property mapped as
+    slugified version of the title, you need to add a property mapped as
     ``Nodename``.
 
     A Document must have an id property. This represents the full path (parent
@@ -272,7 +272,7 @@ you've configured a route to display a specific task by name::
 
 To retrieve objects from the document repository using both the ``find`` and
 ``findMany`` methods and all helper methods of a class-specific repository. In
-PHPCR, it's often unkown for developers which node has the data for a specific
+PHPCR, it's often unknown for developers which node has the data for a specific
 document, in that case you should use the document manager to find the nodes
 (for instance, when you want to get the root document). In example above, we
 know they are ``Task`` documents and so we can use the repository.
@@ -294,7 +294,7 @@ The repository contains all sorts of helpful methods::
 .. tip::
 
     If you use the repository class, you can also create a custom repository
-    for a specific document. This helps with "Seperation of Concern" when using more
+    for a specific document. This helps with "Separation of Concern" when using more
     complex queries. This is similar to how it's done in Doctrine ORM, for
     more information read "`Custom Repository Classes`_" in the core
     documentation.

book/handling_multilang.rst

@@ -56,7 +56,7 @@ Configuring Available Locales
 -----------------------------
 
 The CoreBundle needs to be configure with the available locales. If it is
-not configured with locales, it registeres a listener that removes all
+not configured with locales, it registries a listener that removes all
 translation mapping from PHPCR-ODM documents.
 
 .. configuration-block::

book/installation.rst

@@ -231,7 +231,7 @@ Adding new pages
 Symfony CMF SE does not provide any admin tools to create new pages. If you
 are interested in adding an admin UI one solution can be found in
 :doc:`../tutorial/sonata-admin`. However, if all you want
-is a simple way to add new pages that you can then edit via the inline
+is a simple way to add new pages that you can then edit via the in-line
 editing, then you can use the SimpleCmsBundle ``page`` migrator. For example,
 to add a page called "Testing", creating a file called
 ``app/Resources/data/pages/test.yml`` with the following contents:

book/routing.rst

@@ -496,15 +496,15 @@ also ``/projects`` as there is a default for the id parameter.
 
 .. caution::
 
-    As you can see, the code explicitely creates the ``/cms/routes`` path.
+    As you can see, the code explicitly creates the ``/cms/routes`` path.
     The RoutingBundle only creates this path automatically if the Sonata Admin
     was enabled in the routing configuration using an :ref:`initializer
     <phpcr-odm-repository-initializers>`. Otherwise, it'll assume you do
     something yourself to create the path (by configuring an initializer or
     doing it in a fixture like this).
 
 Because you defined the ``{id}`` route parameter, your controller can expect an
-``$id`` parameter. Additionally, because you called setRouteContent on the
+``$id`` parameter. Additionally, because you called ``setRouteContent`` on the
 route, your controller can expect the ``$contentDocument`` parameter.
 The content could be used to define an intro section that is the same for each
 project or other shared data. If you don't need content, you can just not set it

bundles/block/cache.rst

@@ -139,7 +139,7 @@ is triggered:
   * Cache keys are computed using:
 
     * The cache keys of the block service;
-    * The extraCacheKeys passed from the template.
+    * The ``extraCacheKeys`` passed from the template.
 
   * The cache adapter is asked for a cache element:
 

bundles/block/introduction.rst

@@ -136,8 +136,8 @@ to the `SonataBlockBundle`_ to make it work nicely. This is done using the
 `prepended configuration`_ option of Symfony. The following defaults are
 updated:
 
-* **templates.block_base** the cmf base template wraps the block output in
-  a div and dashifies the PHPCR path as id; The base template is
+* **templates.block_base** the CMF base template wraps the block output in
+  a ``div`` and slugifies the PHPCR path as id; The base template is
   kept compatible with the Sonata base template for non-cmf blocks;
 * **RssBlock configuration** adds the
   :ref:`default RssBlock settings <bundle-block-rss-settings>`.

bundles/block/relation_to_sonata_block_bundle.rst

@@ -4,8 +4,8 @@ Relation to Sonata Block Bundle
 The Symfony2 CMF BlockBundle is based on the `SonataBlockBundle`_.  It replaces
 components of the SonataBlockBundle where needed to be compatible with PHPCR.
 
-Classdiagram
-------------
+Class Diagram
+-------------
 
 The following diagram shows the components the Symfony CMF BlockBundle replaces
 in blue color:

bundles/block/types.rst

@@ -9,10 +9,10 @@ examples to build your own blocks.
 You can also :doc:`create your own blocks <create_your_own_blocks>`, but
 the provided block types should cover many standard cases.
 
-Common Behaviour
-----------------
+Common Behavior
+---------------
 
-There is an ``AbstractBlock`` base class that defines common behaviour for all
+There is an ``AbstractBlock`` base class that defines common behavior for all
 blocks provided by this bundle. It also implements handling for locales, even
 though only those block that actually contain string content implement the
 ``TranslatableInterface``.
@@ -212,7 +212,7 @@ The controller used to fetch the feed items can also be changed:
 
 * Define a different class for the controller service in your configuration
   using the DI service parameter ``cmf_block.rss_controller_class``
-* or set the actionName of your RssBlock document
+* or set the ``actionName`` of your ``RssBlock`` document
 
 .. note::
 
@@ -360,7 +360,7 @@ Make the Slideshow Work in the Front-End
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Since the BlockBundle doesn't contain anything to make the slideshow work
-in the front-end, you need to do this yourself. Use your favourite JavaScript
+in the front-end, you need to do this yourself. Use your favorite JavaScript
 library to make the slideshow interactive. If special markup is needed for
 your slideshow code to work, you can override
 ``BlockBundle:Block:block_slideshow.html.twig`` and/or the templates of the

bundles/content/introduction.rst

@@ -50,7 +50,7 @@ to multiple routes and menu items. A simple page can be created like this::
     $documentManager->flush(); // save changes
 
 This code adds a ``/hello`` route and a ``hello-world`` content document, both
-connected to eachother. This means visiting ``/hello`` should give you the
+connected to each other. This means visiting ``/hello`` should give you the
 content of ``hello-world``. But before that, the correct controller needs to
 be configured.
 

bundles/core/publish_workflow.rst

@@ -265,7 +265,7 @@ is met, but if a single voter returns ``ACCESS_DENIED``, the content is
 considered not published.
 
 You can also implement your :ref:`own voters <bundle-core-workflow-custom-voters>`
-for additional publication behaviour.
+for additional publication behavior.
 
 PublishableVoter
 ................