-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Updated the instructions to build docs locally #6835
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
348b11c
Updated the instructions to build docs locally
javiereguiluz cebc382
Added the missing link references
javiereguiluz a7b4d32
Reword the third step
javiereguiluz c71ad4b
Minor fixes
javiereguiluz 767b49b
Fixed the syntax of the list
javiereguiluz 77c88bf
Fixed again the tricky list syntax
javiereguiluz 914dd30
Fixed the "make" command
javiereguiluz a2428a4
Minor improvements
javiereguiluz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -258,6 +258,33 @@ 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 the Documentation Locally | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Alternatively you can build the documentation in your own computer for testing | ||
purposes following these steps: | ||
|
||
#. Install `pip`_ as explained in the `pip installation`_ article. | ||
|
||
#. 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 | ||
|
||
#. Run the following command to build the documentation in HTML format: | ||
|
||
.. code-block:: bash | ||
|
||
# Linux and macOS | ||
$ ./_build/make html | ||
|
||
# Windows | ||
$ _build\make html | ||
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. on Unix, it should be 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. Maybe this part should be split in two sections ? Unix and Windows ? |
||
|
||
The generated documentation is available in the ``_build/html`` directory. | ||
|
||
Frequently Asked Questions | ||
-------------------------- | ||
|
||
|
@@ -316,3 +343,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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
on your own computer