From a0077a7f78da2842fb43b3bbb49b11b6feecd021 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 2 Apr 2019 10:15:16 +0200 Subject: [PATCH 1/2] Show Docker as the preferred way to build docs locally --- contributing/documentation/overview.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index e0fd5eac618..858c5e05e78 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -249,8 +249,21 @@ GitHub, click on the **Show all checks** link and finally, click on the Build the Documentation Locally ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Alternatively you can build the documentation on your own computer for testing -purposes following these steps: +If you have Docker installed on your machine, run these commands to build docs: + +.. code-block:: terminal + + # build the image... + $ docker build . -t symfony-docs + + # ...and start the local web server + # (if it's already in use, change the '8080' port by any other port) + $ docker run --rm -p 8080:80 symfony-docs + +You can now read the docs at ``http://127.0.0.1:8080`` (if you use a virtual +machine, browse its IP instead of localhost; e.g. ``http://192.168.99.100:8080``). + +If you don't use Docker, follow these other steps to build docs locally: #. Install `pip`_ as explained in the `pip installation`_ article; From 190045d26b14552680328055c622f61d4ee25747 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 2 Apr 2019 10:23:25 +0200 Subject: [PATCH 2/2] Tweaks --- contributing/documentation/overview.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 858c5e05e78..bd0c9564ab4 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -249,7 +249,8 @@ GitHub, click on the **Show all checks** link and finally, click on the Build the Documentation Locally ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you have Docker installed on your machine, run these commands to build docs: +If you have Docker installed on your machine, run these commands to build the +docs: .. code-block:: terminal @@ -263,7 +264,7 @@ If you have Docker installed on your machine, run these commands to build docs: You can now read the docs at ``http://127.0.0.1:8080`` (if you use a virtual machine, browse its IP instead of localhost; e.g. ``http://192.168.99.100:8080``). -If you don't use Docker, follow these other steps to build docs locally: +If you don't use Docker, follow these steps to build the docs locally: #. Install `pip`_ as explained in the `pip installation`_ article;