From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id 4A4D81B891 for ; Thu, 1 Feb 2018 05:01:17 +0100 (CET) Received: from vc2.ecl.ntt.co.jp (vc2.ecl.ntt.co.jp [129.60.86.154]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id w1141GBc004919; Thu, 1 Feb 2018 13:01:16 +0900 Received: from vc2.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id D15E75F612; Thu, 1 Feb 2018 13:01:15 +0900 (JST) Received: from jcms-pop21.ecl.ntt.co.jp (jcms-pop21.ecl.ntt.co.jp [129.60.87.134]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id B5E875F593; Thu, 1 Feb 2018 13:01:15 +0900 (JST) Received: from [IPv6:::1] (watercress.nslab.ecl.ntt.co.jp [129.60.13.73]) by jcms-pop21.ecl.ntt.co.jp (Postfix) with ESMTPSA id 8157740055B; Thu, 1 Feb 2018 13:01:15 +0900 (JST) From: Yasufumi Ogawa Message-ID: <5fa35014-45df-6ad6-cb66-d01b6e698d3b@lab.ntt.co.jp> Date: Thu, 1 Feb 2018 13:00:03 +0900 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-CC-Mail-RelayStamp: 1 To: spp@dpdk.org, ferruh.yigit@intel.com Cc: srv-apl-arch@lab.ntt.co.jp X-TM-AS-MML: disable Subject: [spp] Proposal for RST documentation support 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: Thu, 01 Feb 2018 04:01:18 -0000 Hi, all SPP documentation is currently provided as markdown format. Although it is convenience for hosting on github, I think we need to prepare an official documentation as similar to other DPDK projects considering users. In addition, current documents are not so organized well and some of documents are poor for explanation and should be updated. I would like to send patches for replacing markdown documents to RST. It also includes make command support for compiling and cleaning html documents. $ make doc-html # compile html $ make doc-clean # clean generated documents As a trial, I have uploaded RST documents on readthedocs.io to be reviewed. http://spp.readthedocs.io/en/doc_rst/index.html If it is accpted, I would like to propose DPDK community to add a link to https://dpdk.org/doc as similar as pktgen-dpdk, or hosting it on dpdk.org. Thanks, Yasufumi -- Yasufumi Ogawa NTT Network Service Systems Labs