-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Changes from 3 commits
348b11c
cebc382
a7b4d32
c71ad4b
767b49b
77c88bf
914dd30
a2428a4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Alternatively you can build the documentation in your own computer following | ||
these steps: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
-------------------------- | ||
|
||
|
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Build the Documentation Locally