@@ -229,61 +229,12 @@ this hard work, it's **time to celebrate again!**
229
229
Review your changes
230
230
-------------------
231
231
232
- Every GitHub Pull Request is automatically built and deployed by
233
- `SymfonyCloud `_ on a single environment that you can access on your browser to
234
- review your changes.
232
+ Symfony repository checks every Pull Request automatically to look for common
233
+ errors, inappropriate words, syntax issues in code blocks, etc.
235
234
236
- .. image :: /_images/contributing/docs-pull-request-symfonycloud.png
237
- :align: center
238
- :alt: SymfonyCloud Pull Request Deployment
239
-
240
- To access the `SymfonyCloud `_ environment URL, go to your Pull Request page on
241
- GitHub, click on the **Show all checks ** link and finally, click on the
242
- ``Details `` link displayed for SymfonyCloud service.
243
-
244
- .. note ::
245
-
246
- Only Pull Requests to maintained branches are automatically built by
247
- SymfonyCloud. Check the `roadmap `_ for maintained branches.
248
-
249
- Build the Documentation Locally
250
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251
-
252
- If you have Docker installed on your machine, run these commands to build the
253
- docs:
254
-
255
- .. code-block :: terminal
256
-
257
- # build the image...
258
- $ docker build . -t symfony-docs
259
-
260
- # ...and start the local web server
261
- # (if it's already in use, change the '8080' port by any other port)
262
- $ docker run --rm -p 8080:80 symfony-docs
263
-
264
- You can now read the docs at ``http://127.0.0.1:8080 `` (if you use a virtual
265
- machine, browse its IP instead of localhost; e.g. ``http://192.168.99.100:8080 ``).
266
-
267
- If you don't use Docker, follow these steps to build the docs locally:
268
-
269
- #. Install `pip `_ as explained in the `pip installation `_ article;
270
-
271
- #. Install `Sphinx `_ and `Sphinx Extensions for PHP and Symfony `_
272
- (depending on your system, you may need to execute this command as root user):
273
-
274
- .. code-block :: terminal
275
-
276
- $ cd _build/
277
- $ pip install -r .requirements.txt
278
-
279
- #. Run the following command to build the documentation in HTML format:
280
-
281
- .. code-block :: terminal
282
-
283
- $ cd _build/
284
- $ make html
285
-
286
- The generated documentation is available in the ``_build/html `` directory.
235
+ Optionally you can also build the docs in your local machine to debug issues or
236
+ to read the documentation offline. To do so, follow the instructions included in
237
+ `the README file of symfony-docs repository `_.
287
238
288
239
Frequently Asked Questions
289
240
--------------------------
@@ -342,7 +293,4 @@ definitely don't want you to waste your time!
342
293
.. _`Symfony Documentation Badge` : https://connect.symfony.com/badge/36/symfony-documentation-contributor
343
294
.. _`SymfonyCloud` : https://symfony.com/cloud
344
295
.. _`roadmap` : https://symfony.com/releases
345
- .. _`pip` : https://pip.pypa.io/en/stable/
346
- .. _`pip installation` : https://pip.pypa.io/en/stable/installing/
347
- .. _`Sphinx` : https://www.sphinx-doc.org/
348
- .. _`Sphinx Extensions for PHP and Symfony` : https://github.com/fabpot/sphinx-php
296
+ .. _`the README file of symfony-docs repository` : https://github.com/symfony/symfony-docs#readme
0 commit comments