Skip to content

Commit 77cf1a5

Browse files
committed
Fix Sphinx syntax errors in the documentation
1 parent 10115f0 commit 77cf1a5

File tree

15 files changed

+22
-23
lines changed

15 files changed

+22
-23
lines changed

_build/.requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ snowballstemmer==1.2.1
1212
sphinx==1.8.5
1313
git+https://github.com/fabpot/[email protected]#egg_name=sphinx-php
1414
sphinxcontrib-phpdomain==0.6.3
15+
jsx-lexer===0.0.8

best_practices/creating-the-project.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ to create files and execute the following commands:
2727

2828
**Linux and macOS systems**:
2929

30-
.. class:: command-linux
30+
.. rst-class:: command-linux
3131
.. code-block:: terminal
3232
3333
$ cd projects/
3434
$ symfony new blog --version=3.4
3535
3636
**Windows systems**:
3737

38-
.. class:: command-windows
38+
.. rst-class:: command-windows
3939
.. code-block:: terminal
4040
4141
> cd projects/

components/asset.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,6 @@ corresponding output file:
147147

148148
.. code-block:: json
149149
150-
// rev-manifest.json
151150
{
152151
"css/app.css": "build/css/app.b916426ea1d10021f3f17ce8031f93c2.css",
153152
"js/app.js": "build/js/app.13630905267b809161e71d0f8a0c017b.js",
@@ -160,6 +159,7 @@ In those cases, use the
160159
use Symfony\Component\Asset\Package;
161160
use Symfony\Component\Asset\VersionStrategy\JsonManifestVersionStrategy;
162161

162+
// assumes the JSON file above is called "rev-manifest.json"
163163
$package = new Package(new JsonManifestVersionStrategy(__DIR__.'/rev-manifest.json'));
164164

165165
echo $package->getUrl('css/app.css');

components/lock.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ object) and ``isExpired()`` (which returns a boolean).
155155
The Owner of The Lock
156156
---------------------
157157

158-
Locks that are acquired for the first time are owned[1]_ by the ``Lock`` instance that acquired
158+
Locks that are acquired for the first time are owned [1]_ by the ``Lock`` instance that acquired
159159
it. If you need to check whether the current ``Lock`` instance is (still) the owner of
160160
a lock, you can use the ``isAcquired()`` method::
161161

controller.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ the argument by its name:
314314
315315
<!-- Explicitly configure the service -->
316316
<service id="AppBundle\Controller\LuckyController">
317-
<tag name"controller.service_arguments"/>
317+
<tag name="controller.service_arguments"/>
318318
<bind key="$logger"
319319
type="service"
320320
id="monolog.logger.doctrine"

frontend/encore/vuejs.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,9 @@ Using styles
7878
You can't use ``<style>`` in ``.jsx`` files. As a workaround, you can import
7979
``.css``, ``.scss``, etc. files manually:
8080

81-
.. code-block:: javascript
81+
.. code-block:: jsx
8282
8383
// App.jsx
84-
8584
import './App.css'
8685
8786
export default {
@@ -107,10 +106,9 @@ You can't use `Scoped Styles`_ (``<style scoped>``) either in ``.jsx`` files. As
107106
a workaround, you can use `CSS Modules`_ by suffixing import paths with
108107
``?module``:
109108

110-
.. code-block:: javascript
109+
.. code-block:: jsx
111110
112111
// Component.jsx
113-
114112
import styles from './Component.css?module' // suffix with "?module"
115113
116114
export default {
@@ -142,7 +140,7 @@ Using images
142140
You can't use ``<img src="./image.png">`` in ``.jsx`` files. As a workaround,
143141
you can import them with ``require()`` function:
144142

145-
.. code-block:: javascript
143+
.. code-block:: jsx
146144
147145
export default {
148146
name: 'Component',

reference/configuration/debug.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ key in your application configuration.
2525
Configuration
2626
-------------
2727

28-
.. class:: list-config-options
28+
.. rst-class:: list-config-options
2929

3030
* `dump_destination`_
3131
* `max_items`_

reference/configuration/framework.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ configured under the ``framework`` key in your application configuration.
2727
Configuration
2828
-------------
2929

30-
.. class:: list-config-options list-config-options--complex
30+
.. rst-class:: list-config-options list-config-options--complex
3131

3232
* `annotations`_
3333

reference/configuration/swiftmailer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to :doc:`send emails </email>`. All these options are configured under the
2525
Configuration
2626
-------------
2727

28-
.. class:: list-config-options list-config-options--complex
28+
.. rst-class:: list-config-options list-config-options--complex
2929

3030
* `antiflood`_
3131

reference/configuration/twig.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ the ``twig`` key in your application configuration.
2525
Configuration
2626
-------------
2727

28-
.. class:: list-config-options list-config-options--complex
28+
.. rst-class:: list-config-options list-config-options--complex
2929

3030
* `auto_reload`_
3131
* `autoescape`_

reference/configuration/web_profiler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ execution and displays it in both the web debug toolbar and the
3030
Configuration
3131
-------------
3232

33-
.. class:: list-config-options
33+
.. rst-class:: list-config-options
3434

3535
* `excluded_ajax_paths`_
3636
* `intercept_redirects`_

reference/forms/twig_reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ array).
197197

198198
.. code-block:: html+twig
199199

200-
<option {% if choice is selectedchoice(value) %} selected="selected"{% endif %} ...>
200+
<option {% if choice is selectedchoice(value) %} selected="selected"{% endif %} {# ... #}>
201201

202202
.. _form-twig-rootform:
203203

@@ -247,7 +247,7 @@ of variables. By default, these blocks live inside `form_div_layout.html.twig`_.
247247

248248
Look at the ``form_label`` as an example:
249249

250-
.. code-block:: html+twig
250+
.. code-block:: twig
251251
252252
{% block form_label %}
253253
{% if not compound %}

security/remember_me.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ so ``DoctrineTokenProvider`` can store the tokens:
328328
329329
.. code-block:: xml
330330
331-
<doctrine:dbal schema-filter="~^(?!rememberme_token)~" .../>
331+
<doctrine:dbal schema-filter="~^(?!rememberme_token)~"/>
332332
333333
.. code-block:: php
334334

service_container.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,12 +1183,12 @@ unique string as the key of each service config:
11831183
<services>
11841184
<prototype namespace="AppBundle\Domain"
11851185
resource="../../src/AppBundle/Domain/*/CommandHandler"/>
1186-
<tag name"command_handler"/>
1186+
<tag name="command_handler"/>
11871187
</prototype>
11881188
11891189
<prototype namespace="AppBundle\Domain"
11901190
resource="../../src/AppBundle/Domain/*/EventSubscriber"/>
1191-
<tag name"event_subscriber"/>
1191+
<tag name="event_subscriber"/>
11921192
</prototype>
11931193
11941194
<!-- ... -->

setup.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ executable that needs to be installed on your system only once:
2222

2323
**Linux and macOS systems**:
2424

25-
.. class:: command-linux
25+
.. rst-class:: command-linux
2626
.. code-block:: terminal
2727
2828
$ sudo mkdir -p /usr/local/bin
@@ -31,7 +31,7 @@ executable that needs to be installed on your system only once:
3131
3232
**Windows systems**:
3333

34-
.. class:: command-windows
34+
.. rst-class:: command-windows
3535
.. code-block:: terminal
3636
3737
> php -r "file_put_contents('symfony', file_get_contents('https://symfony.com/installer'));"
@@ -43,7 +43,7 @@ executable that needs to be installed on your system only once:
4343
environment variable and create a ``symfony.bat`` file to create the global
4444
command or move it to any other directory convenient for you:
4545

46-
.. class:: command-windows
46+
.. rst-class:: command-windows
4747
.. code-block:: terminal
4848
4949
# for example, if WAMP is used ...

0 commit comments

Comments
 (0)