File tree Expand file tree Collapse file tree 2 files changed +19
-15
lines changed
contributing/documentation Expand file tree Collapse file tree 2 files changed +19
-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 @@ -258,6 +258,24 @@ link displayed for Platform.sh service.
258
258
Only Pull Requests to maintained branches are automatically built by
259
259
Platform.sh. Check the `roadmap `_ for maintained branches.
260
260
261
+ Build Documentation Locally
262
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
263
+
264
+ Alternatively you can build the documentation in your own computer following
265
+ these steps:
266
+
267
+ **Step 1. ** Install `pip `_ as explained in the `pip installation `_ article.
268
+
269
+ **Step 2. ** Install `Sphinx `_ and `Sphinx Extensions for PHP and Symfony `_
270
+ (depending on your system, you may need to execute this command as root user):
271
+
272
+ .. code-block :: bash
273
+
274
+ $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git
275
+
276
+ **Step 3. ** Run ``make html `` and view the generated documentation in the
277
+ ``_build/html `` directory.
278
+
261
279
Frequently Asked Questions
262
280
--------------------------
263
281
You can’t perform that action at this time.
0 commit comments