File tree 2 files changed +27
-15
lines changed
contributing/documentation 2 files changed +27
-15
lines changed Original file line number Diff line number Diff line change @@ -27,7 +27,7 @@ tutorial and the `reStructuredText Reference`_.
27
27
Sphinx
28
28
------
29
29
30
- Sphinx is a build system that provides tools to create documentation from
30
+ Sphinx _ is a build system that provides tools to create documentation from
31
31
reStructuredText documents. As such, it adds new directives and interpreted text
32
32
roles to the standard reST markup. Read more about the `Sphinx Markup Constructs `_.
33
33
@@ -198,20 +198,6 @@ reached end-of-maintenance will be removed. For example, if Symfony 2.5 were
198
198
released today, and 2.2 had recently reached its end-of-life, the 2.2 ``versionadded ``
199
199
tags would be removed from the new ``2.5 `` branch.
200
200
201
- Testing Documentation
202
- ~~~~~~~~~~~~~~~~~~~~~
203
-
204
- When submitting a new content to the documentation repository or when changing
205
- any existing resource, an automatic process will check if your documentation is
206
- free of syntax errors and is ready to be reviewed.
207
-
208
- Nevertheless, if you prefer to do this check locally on your own machine before
209
- submitting your documentation, follow these steps:
210
-
211
- * Install Sphinx _;
212
- * Install the Sphinx extensions using git submodules: ``$ git submodule update --init ``;
213
- * Run ``make html `` and view the generated HTML in the ``_build/html `` directory.
214
-
215
201
.. _reStructuredText : http://docutils.sourceforge.net/rst.html
216
202
.. _Sphinx : http://sphinx-doc.org/
217
203
.. _`Symfony documentation` : https://github.com/symfony/symfony-docs
Original file line number Diff line number Diff line change @@ -274,6 +274,28 @@ page on GitHub and click on ``Details``.
274
274
Only Pull Requests to maintained branches are automatically built by
275
275
Platform.sh. Check the `roadmap `_ for maintained branches.
276
276
277
+ Building from source
278
+ --------------------
279
+
280
+ If you want to build documentation from source on your local machine, follow
281
+ these steps:
282
+
283
+ **Step 1. ** Install pip _ (follow the `pip installation `_ chapter).
284
+
285
+ **Step 2. ** Install Sphinx _ and `Sphinx Extensions for PHP and Symfony `_.
286
+
287
+ .. code-block :: bash
288
+
289
+ $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git
290
+
291
+ .. caution ::
292
+
293
+ You should install Sphinx and Shpinx extensions globally on your system. It
294
+ means that above command should be executed as root user.
295
+
296
+ **Step 3. ** Run ``make html `` and view the generated HTML in the ``_build/html ``
297
+ directory.
298
+
277
299
Minor Changes (e.g. Typos)
278
300
--------------------------
279
301
@@ -346,4 +368,8 @@ definitely don't want you to waste your time!
346
368
.. _`Symfony Documentation Badge` : https://connect.sensiolabs.com/badge/36/symfony-documentation-contributor
347
369
.. _`sync your fork` : https://help.github.com/articles/syncing-a-fork
348
370
.. _`Platform.sh` : https://platform.sh
371
+ .. _pip : https://pip.pypa.io/en/stable/
372
+ .. _`pip installation` : https://pip.pypa.io/en/stable/installing/
373
+ .. _Sphinx : http://sphinx-doc.org/
374
+ .. _`Sphinx Extensions for PHP and Symfony` : https://github.com/fabpot/sphinx-php
349
375
.. _`roadmap` : https://symfony.com/roadmap
You can’t perform that action at this time.
0 commit comments