Skip to content

Commit

Permalink
Updated the instructions to build docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
javiereguiluz committed Aug 3, 2016
1 parent 47bda31 commit 348b11c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
16 changes: 1 addition & 15 deletions contributing/documentation/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ tutorial and the `reStructuredText Reference`_.
Sphinx
------

Sphinx is a build system that provides tools to create documentation from
Sphinx_ is a build system that provides tools to create documentation from
reStructuredText documents. As such, it adds new directives and interpreted text
roles to the standard reST markup. Read more about the `Sphinx Markup Constructs`_.

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

Testing Documentation
~~~~~~~~~~~~~~~~~~~~~

When submitting a new content to the documentation repository or when changing
any existing resource, an automatic process will check if your documentation is
free of syntax errors and is ready to be reviewed.

Nevertheless, if you prefer to do this check locally on your own machine before
submitting your documentation, follow these steps:

* Install Sphinx_;
* Install the Sphinx extensions using git submodules: ``$ git submodule update --init``;
* Run ``make html`` and view the generated HTML in the ``_build/html`` directory.

.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
.. _`Symfony documentation`: https://github.com/symfony/symfony-docs
Expand Down
18 changes: 18 additions & 0 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,24 @@ link displayed for Platform.sh service.
Only Pull Requests to maintained branches are automatically built by
Platform.sh. Check the `roadmap`_ for maintained branches.

Build Documentation Locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Alternatively you can build the documentation in your own computer following
these steps:

**Step 1.** Install `pip`_ as explained in the `pip installation`_ article.

**Step 2.** Install `Sphinx`_ and `Sphinx Extensions for PHP and Symfony`_
(depending on your system, you may need to execute this command as root user):

.. code-block:: bash
$ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git
**Step 3.** Run ``make html`` and view the generated documentation in the
``_build/html`` directory.

Frequently Asked Questions
--------------------------

Expand Down

0 comments on commit 348b11c

Please sign in to comment.