Skip to content

Updated the instructions to build docs locally #6835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 20, 2016
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
28 changes: 28 additions & 0 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,30 @@ 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build the Documentation Locally

~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

@yceruto yceruto Aug 4, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I was confused in thinking that could build the documentation locally and use it completely "offline", which it's not possible right now and probably never will #6844 (comment). Maybe we can add the subject "only for testing purpose" somehow? The previous title/description it was clearer in this sense, thanks.


**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 the following command to build the documentation in HTML format:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use an ordered list here


.. code-block:: bash

$ cd _build/
$ make html

The generated documentation is available in the ``_build/html`` directory.

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

Expand Down Expand Up @@ -316,3 +340,7 @@ definitely don't want you to waste your time!
.. _`sync your fork`: https://help.github.com/articles/syncing-a-fork
.. _`Platform.sh`: https://platform.sh
.. _`roadmap`: https://symfony.com/roadmap
.. _`pip`: https://pip.pypa.io/en/stable/
.. _`pip installation`: https://pip.pypa.io/en/stable/installing/
.. _`Sphinx`: http://sphinx-doc.org/
.. _`Sphinx Extensions for PHP and Symfony`: https://github.com/fabpot/sphinx-php