Added Spelling builder and word list

Author: wouterj

.gitignore

@@ -1,3 +1,4 @@
 /_build/doctrees
+/_build/spelling
 /_build/html
 *.pyc

_build/.requirements.txt

@@ -10,4 +10,5 @@ requests==2.20.0
 six==1.10.0
 snowballstemmer==1.2.1
 Sphinx==1.3.6
+sphinxcontrib.spelling
 git+https://github.com/fabpot/sphinx-php.git@7312eccce9465640752e51373a480da700e02345#egg_name=sphinx-php

_build/conf.py

@@ -36,9 +36,14 @@
 extensions = [
     'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
     'sensio.sphinx.refinclude', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode', 'sensio.sphinx.bestpractice', 'sensio.sphinx.codeblock',
-    'symfonycom.sphinx'
+    'symfonycom.sphinx',
+    'sphinxcontrib.spelling'
 ]
 
+spelling_show_sugestions=True
+spelling_lang='en_US'
+spelling_word_list_filename='_build/spelling_word_list.txt'
+
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_theme/_templates']
 

_build/spelling_word_list.txt

@@ -0,0 +1,200 @@
+accessor
+advertize
+analytics
+Ansi
+Ansible
+Assetic
+autocompleted
+autocompletion
+autoconfiguration
+autoconfigured
+autoload
+autoloaded
+autoloader
+autoloaders
+autoloading
+autowire
+autowiring
+backend
+backends
+benchmarking
+bitwise
+boolean
+booleans
+callables
+camelCase
+casted
+changelog
+charset
+charsets
+checkboxes
+classmap
+classname
+clearers
+cloner
+cloners
+codebase
+config
+contrib
+cronjobs
+cryptographic
+cryptographically
+ctype
+customizable
+Cygwin
+dataset
+denormalization
+denormalize
+denormalized
+deprecations
+deserialization
+deserialize
+deserializing
+destructor
+dev
+DNS
+docblock
+Dotenv
+enum
+env
+escaper
+escpaer
+extensibility
+extractable
+eZPublish
+failover
+filesystem
+filesystems
+formatter
+formatters
+frontend
+getter
+getters
+GitHub
+Goutte
+grapheme
+hardcode
+hardcoded
+hardcodes
+hardcoding
+hasser
+hassers
+hostname
+https
+iconv
+igbinary
+ini
+inlined
+interoperable
+intl
+Intl
+invokable
+isser
+issers
+jQuery
+Kubernetes
+labelled
+Ldap
+libketama
+licensor
+lifecycle
+localhost
+matcher
+matchers
+mbstring
+memcached
+minify
+misgendering
+Monolog
+mutator
+nagle
+namespace
+namespaced
+namespaces
+namespacing
+nd
+NGINX
+normalizer
+normalizers
+OPcache
+overcomplicate
+Packagist
+parallelizes
+parsers
+PHP
+PHPUnit
+PID
+polyfill
+polyfills
+pre
+Predis
+preload
+preloaded
+prepend
+prepended
+prepending
+prepends
+profiler
+programmatically
+prototyped
+rebase
+reconnection
+redirections
+refactorization
+regexes
+resolvers
+responder
+reStructuredText
+runtime
+serializable
+serializer
+sexualized
+Silex
+socio
+specificities
+SQLite
+stacktrace
+stacktraces
+storages
+stylesheets
+subclasses
+subdirectories
+sublcasses
+sublicense
+sublincense
+subtree
+superclass
+superglobal
+superglobals
+Symfony
+symlinks
+syntaxes
+templating
+testability
+th
+theming
+throbber
+TLS
+tmpfs
+todo
+triaging
+UI
+unary
+uncomment
+uncommented
+unmapped
+unported
+unregister
+unsubmitted
+uploader
+validator
+validators
+variadic
+VirtualBox
+webserver
+whitespace
+Wordpress
+Xliff
+XML
+XPath
+yaml

best_practices/creating-the-project.rst

@@ -106,7 +106,7 @@ following:
 Application Bundles
 ~~~~~~~~~~~~~~~~~~~
 
-When Symfony 2.0 was released, most developers naturally adopted the symfony
+When Symfony 2.0 was released, most developers naturally adopted the Symfony
 1.x way of dividing applications into logical modules. That's why many Symfony
 applications use bundles to divide their code into logical features: UserBundle,
 ProductBundle, InvoiceBundle, etc.

bundles/best_practices.rst

@@ -188,7 +188,7 @@ The index file (for example ``Resources/doc/index.rst`` or
 ``Resources/doc/index.md``) is the only mandatory file and must be the entry
 point for the documentation. The
 :doc:`reStructuredText (rST) </contributing/documentation/format>` is the format
-used to render the documentation on symfony.com.
+used to render the documentation on ``symfony.com``.
 
 Installation Instructions
 ~~~~~~~~~~~~~~~~~~~~~~~~~

components/cache/adapters/php_array_cache_adapter.rst

@@ -2,7 +2,7 @@
     single: Cache Pool
     single: PHP Array Cache
 
-Php Array Cache Adapter
+PHP Array Cache Adapter
 =======================
 
 This adapter is a high performance cache for static data (e.g. application configuration)

components/cache/adapters/php_files_adapter.rst

@@ -4,7 +4,7 @@
 
 .. _component-cache-files-adapter:
 
-Php Files Cache Adapter
+PHP Files Cache Adapter
 =======================
 
 Similarly to :ref:`Filesystem Adapter <component-cache-filesystem-adapter>`, this cache

components/dotenv.rst

@@ -28,7 +28,7 @@ Sensitive information and environment-dependent settings should be defined as
 environment variables (as recommended for `twelve-factor applications`_). Using
 a ``.env`` file to store those environment variables eases development and CI
 management by keeping them in one "standard" place and agnostic of the
-technology stack you are using (Nginx vs PHP built-in server for instance).
+technology stack you are using (NGINX vs PHP built-in server for instance).
 
 .. note::
 

components/http_foundation.rst

@@ -477,10 +477,10 @@ represented by a PHP callable instead of a string::
 
     Additionally, PHP isn't the only layer that can buffer output. Your web
     server might also buffer based on its configuration. Some servers, such as
-    Nginx, let you disable buffering at the config level or by adding a special HTTP
+    NGINX, let you disable buffering at the config level or by adding a special HTTP
     header in the response::
 
-        // disables FastCGI buffering in Nginx only for this response
+        // disables FastCGI buffering in NGINX only for this response
         $response->headers->set('X-Accel-Buffering', 'no')
 
 .. _component-http-foundation-serving-files:
@@ -517,7 +517,7 @@ Alternatively, if you are serving a static file, you can use a
 
 The ``BinaryFileResponse`` will automatically handle ``Range`` and
 ``If-Range`` headers from the request. It also supports ``X-Sendfile``
-(see for `Nginx`_ and `Apache`_). To make use of it, you need to determine
+(see for `NGINX`_ and `Apache`_). To make use of it, you need to determine
 whether or not the ``X-Sendfile-Type`` header should be trusted and call
 :method:`Symfony\\Component\\HttpFoundation\\BinaryFileResponse::trustXSendfileTypeHeader`
 if it should::
@@ -665,7 +665,7 @@ Learn More
     /session/*
     /http_cache/*
 
-.. _Nginx: https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/
+.. _NGINX: https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/
 .. _Apache: https://tn123.org/mod_xsendfile/
 .. _`JSON Hijacking`: http://haacked.com/archive/2009/06/25/json-hijacking.aspx
 .. _OWASP guidelines: https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside

components/http_foundation/session_configuration.rst

@@ -23,7 +23,7 @@ Native PHP Save Handlers
 ------------------------
 
 So-called native handlers, are save handlers which are either compiled into
-PHP or provided by PHP extensions, such as PHP-Sqlite, PHP-Memcached and so on.
+PHP or provided by PHP extensions, such as PHP-SQLite, PHP-Memcached and so on.
 
 All native save handlers are internal to PHP and as such, have no public facing API.
 They must be configured by ``php.ini`` directives, usually ``session.save_path`` and

components/intl.rst

@@ -116,7 +116,7 @@ PhpBundleWriter
 ~~~~~~~~~~~~~~~
 
 The :class:`Symfony\\Component\\Intl\\ResourceBundle\\Writer\\PhpBundleWriter`
-writes an array or an array-like object to a .php resource bundle::
+writes an array or an array-like object to a ``.php`` resource bundle::
 
     use Symfony\Component\Intl\ResourceBundle\Writer\PhpBundleWriter;
 
@@ -147,7 +147,7 @@ PhpBundleReader
 ~~~~~~~~~~~~~~~
 
 The :class:`Symfony\\Component\\Intl\\ResourceBundle\\Reader\\PhpBundleReader`
-reads resource bundles from .php files and returns an array or an array-like
+reads resource bundles from ``.php`` files and returns an array or an array-like
 object::
 
     use Symfony\Component\Intl\ResourceBundle\Reader\PhpBundleReader;

components/phpunit_bridge.rst

@@ -145,7 +145,7 @@ a directory containing multiple test suites with their own ``phpunit.xml.dist``.
     $ ./vendor/bin/simple-phpunit tests/
 
 The modified PHPUnit script will recursively go through the provided directory,
-up to a depth of 3 subfolders or the value specified by the environment variable
+up to a depth of 3 subdirectories or the value specified by the environment variable
 ``SYMFONY_PHPUNIT_MAX_DEPTH``, looking for ``phpunit.xml.dist`` files and then
 running each suite it finds in parallel, collecting their output and displaying
 each test suite's results in their own section.
@@ -558,7 +558,7 @@ classes' namespace. In order to work as expected, the listener has to run before
 the tested class ever runs. By default, the mocked functions are created when the
 annotation are found and the corresponding tests are run. Depending on how your
 tests are constructed, this might be too late. In this case, you will need to declare
-the namespaces of the tested classes in your phpunit.xml.dist
+the namespaces of the tested classes in your ``phpunit.xml.dist``.
 
 .. code-block:: xml
 

components/process.rst

@@ -387,10 +387,10 @@ When running a program asynchronously, you can send it POSIX signals with the
     // will send a SIGKILL to the process
     $process->signal(SIGKILL);
 
-Process Pid
+Process PID
 -----------
 
-You can access the `pid`_ of a running process with the
+You can access the `PID`_ of a running process with the
 :method:`Symfony\\Component\\Process\\Process::getPid` method::
 
     use Symfony\Component\Process\Process;
@@ -443,6 +443,6 @@ absolute path of the executable PHP binary available on your server::
     $phpBinaryPath = $phpBinaryFinder->find();
     // $phpBinaryPath = '/usr/local/bin/php' (the result will be different on your computer)
 
-.. _`pid`: https://en.wikipedia.org/wiki/Process_identifier
+.. _`PID`: https://en.wikipedia.org/wiki/Process_identifier
 .. _`PHP streams`: https://www.php.net/manual/en/book.stream.php
 .. _`output_buffering`: https://www.php.net/manual/en/outcontrol.configuration.php

configuration.rst

@@ -8,8 +8,8 @@ Every Symfony application consists of a collection of bundles that add useful to
 (:doc:`services </service_container>`) to your project. Each bundle can be customized
 via configuration files that live - by default - in the ``app/config`` directory.
 
-Configuration: config.yml
--------------------------
+Configuration: ``config.yml``
+-----------------------------
 
 The main configuration file is called ``config.yml``:
 
@@ -297,8 +297,8 @@ a controller - see :ref:`service-container-parameters`.
 
 .. _config-parameters-yml:
 
-The Special parameters.yml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Special ``parameters.yml`` File
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 On the surface, ``parameters.yml`` is just like any other configuration file: it
 is imported by ``config.yml`` and defines several parameters: