File tree Expand file tree Collapse file tree 1 file changed +11
-12
lines changed
contributing/documentation Expand file tree Collapse file tree 1 file changed +11
-12
lines changed Original file line number Diff line number Diff line change @@ -258,27 +258,26 @@ 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- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
261+ Build the Documentation Locally
262+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
263263
264264Alternatively you can build the documentation in your own computer following
265265these steps:
266266
267- **Step 1. ** Install `pip `_ as explained in the `pip installation `_ article.
267+ 1. Install `pip `_ as explained in the `pip installation `_ article.
268+ 2. Install `Sphinx `_ and `Sphinx Extensions for PHP and Symfony `_
269+ (depending on your system, you may need to execute this command as root user):
268270
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+ .. code-block :: bash
271272
272- .. code-block :: bash
273-
274- $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git
273+ $ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git
275274
276- ** Step 3. ** Run the following command to build the documentation in HTML format:
275+ 3. Run the following command to build the documentation in HTML format:
277276
278- .. code-block :: bash
277+ .. code-block :: bash
279278
280- $ cd _build/
281- $ make html
279+ $ cd _build/
280+ $ make html
282281
283282 The generated documentation is available in the ``_build/html `` directory.
284283
You can’t perform that action at this time.
0 commit comments