From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw1001.ocn.ad.jp (mogw1001.ocn.ad.jp [153.149.231.7]) by dpdk.org (Postfix) with ESMTP id 766C35A6A for ; Wed, 13 Feb 2019 15:21:07 +0100 (CET) Received: from mf-smf-unw008c2 (mf-smf-unw008c2.ocn.ad.jp [153.138.219.103]) by mogw1001.ocn.ad.jp (Postfix) with ESMTP id DDDCD1200539; Wed, 13 Feb 2019 23:21:05 +0900 (JST) Received: from ocn-vc-mts-205c1.ocn.ad.jp ([125.206.160.23]) by mf-smf-unw008c2 with ESMTP id tvHEgeQEwqOE8tvPNgBOcX; Wed, 13 Feb 2019 23:21:05 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.167]) by ocn-vc-mts-205c1.ocn.ad.jp with ESMTP id tvPNgVB1Xtz0QtvPNgP6AN; Wed, 13 Feb 2019 23:21:05 +0900 Received: from localhost.localdomain (unknown [192.47.164.146]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Wed, 13 Feb 2019 23:21:05 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Wed, 13 Feb 2019 23:21:04 +0900 Message-Id: <20190213142104.33096-3-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190213142104.33096-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20190213142104.33096-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 2/2] docs: add desc to build docs on Ubuntu 18.04 X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 13 Feb 2019 14:21:07 -0000 From: Yasufumi Ogawa Instruction for building documentation is only for Ubuntu 16.04 LTS and it is not considered for 18.04. It is required to install `latexmk` if you use 18.04, and this update is to add the instruction. Signed-off-by: Yasufumi Ogawa --- docs/guides/setup/getting_started.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/guides/setup/getting_started.rst b/docs/guides/setup/getting_started.rst index 9847903..8cda22b 100644 --- a/docs/guides/setup/getting_started.rst +++ b/docs/guides/setup/getting_started.rst @@ -387,6 +387,13 @@ For PDF, inkscape and latex packages are required. $ sudo apt install texlive-latex-extra $ sudo apt install texlive-latex-recommended +You might also need to install ``latexmk`` in addition to if you use +Ubuntu 18.04 LTS. + +.. code-block:: console + + $ sudo apt install latexmk + HTML documentation is compiled by running make with ``doc-html``. This command launch sphinx for compiling HTML documents. Compiled HTML files are created in ``docs/guides/_build/html/`` and -- 2.17.1