Skip to content

Commit 8785e39

Browse files
committed
Merge branch '3.4' into 4.2
* 3.4: Show Docker as the preferred way to build docs locally
2 parents 07b8159 + 3d1b501 commit 8785e39

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

contributing/documentation/overview.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,22 @@ GitHub, click on the **Show all checks** link and finally, click on the
249249
Build the Documentation Locally
250250
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251251

252-
Alternatively you can build the documentation on your own computer for testing
253-
purposes following these steps:
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:
254268

255269
#. Install `pip`_ as explained in the `pip installation`_ article;
256270

0 commit comments

Comments
 (0)