From patchwork Wed Apr 3 11:04:11 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dekel Peled X-Patchwork-Id: 52170 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 0A0871B20E; Wed, 3 Apr 2019 13:05:53 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id 595F41B209 for ; Wed, 3 Apr 2019 13:05:51 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from dekelp@mellanox.com) with ESMTPS (AES256-SHA encrypted); 3 Apr 2019 14:05:48 +0300 Received: from mtl-vdi-280.wap.labs.mlnx. (mtl-vdi-280.wap.labs.mlnx [10.128.130.87]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x33B5mvx026609; Wed, 3 Apr 2019 14:05:48 +0300 From: Dekel Peled To: john.mcnamara@intel.com, marko.kovacevic@intel.com Cc: dev@dpdk.org, orika@mellanox.com, stable@dpdk.org Date: Wed, 3 Apr 2019 14:04:11 +0300 Message-Id: <5bffbf5d7059e676f2f0a0a7f4eb21193e6ddc69.1554289489.git.dekelp@mellanox.com> X-Mailer: git-send-email 1.7.1 Subject: [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Update broken links, replace with valid links. Fixes: 7798f17a0d62 ("doc: add documentation guidelines") Cc: stable@dpdk.org Signed-off-by: Dekel Peled --- doc/guides/contributing/documentation.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index baf0921..7a2f81a 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -39,14 +39,14 @@ The main directories that contain files related to documentation are shown below |-- ... -The API documentation is built from `Doxygen `_ comments in the header files. +The API documentation is built from `Doxygen `_ comments in the header files. These files are mainly in the ``lib/librte_*`` directories although some of the Poll Mode Drivers in ``drivers/net`` are also documented with Doxygen. The configuration files that are used to control the Doxygen output are in the ``doc/api`` directory. The user guides such as *The Programmers Guide* and the *FreeBSD* and *Linux Getting Started* Guides are generated -from RST markup text files using the `Sphinx `_ Documentation Generator. +from RST markup text files using the `Sphinx `_ Documentation Generator. These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. @@ -173,7 +173,7 @@ For full support with figure and table captioning the latest version of Sphinx c sudo pip install --upgrade sphinx sudo pip install --upgrade sphinx_rtd_theme -For further information on getting started with Sphinx see the `Sphinx Tutorial `_. +For further information on getting started with Sphinx see the `Sphinx Getting Started `_. .. Note:: @@ -595,7 +595,7 @@ Doxygen Guidelines The DPDK API is documented using Doxygen comment annotations in the header files. Doxygen is a very powerful tool, it is extremely configurable and with a little effort can be used to create expressive documents. -See the `Doxygen website `_ for full details on how to use it. +See the `Doxygen website `_ for full details on how to use it. The following are some guidelines for use of Doxygen in the DPDK API documentation: