Skip to content

Commit 348b11c

Browse files
committed
Updated the instructions to build docs locally
1 parent 47bda31 commit 348b11c

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-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: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,24 @@ link displayed for Platform.sh service.
258258
Only Pull Requests to maintained branches are automatically built by
259259
Platform.sh. Check the `roadmap`_ for maintained branches.
260260

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+
261279
Frequently Asked Questions
262280
--------------------------
263281

0 commit comments

Comments
 (0)