Skip to content

Commit d5e0be4

Browse files
committed
Fix build instructions
1 parent 1e1ab96 commit d5e0be4

File tree

2 files changed

+27
-15
lines changed

2 files changed

+27
-15
lines changed

contributing/documentation/format.rst

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ tutorial and the `reStructuredText Reference`_.
2727
Sphinx
2828
------
2929

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
3131
reStructuredText documents. As such, it adds new directives and interpreted text
3232
roles to the standard reST markup. Read more about the `Sphinx Markup Constructs`_.
3333

@@ -198,20 +198,6 @@ reached end-of-maintenance will be removed. For example, if Symfony 2.5 were
198198
released today, and 2.2 had recently reached its end-of-life, the 2.2 ``versionadded``
199199
tags would be removed from the new ``2.5`` branch.
200200

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-
215201
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
216202
.. _Sphinx: http://sphinx-doc.org/
217203
.. _`Symfony documentation`: https://github.com/symfony/symfony-docs

contributing/documentation/overview.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,28 @@ page on GitHub and click on ``Details``.
274274
Only Pull Requests to maintained branches are automatically built by
275275
Platform.sh. Check the `roadmap`_ for maintained branches.
276276

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+
277299
Minor Changes (e.g. Typos)
278300
--------------------------
279301

@@ -346,4 +368,8 @@ definitely don't want you to waste your time!
346368
.. _`Symfony Documentation Badge`: https://connect.sensiolabs.com/badge/36/symfony-documentation-contributor
347369
.. _`sync your fork`: https://help.github.com/articles/syncing-a-fork
348370
.. _`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
349375
.. _`roadmap`: https://symfony.com/roadmap

0 commit comments

Comments
 (0)