From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail04.ics.ntt-tx.co.jp (mail05.ics.ntt-tx.co.jp [210.232.35.69]) by dpdk.org (Postfix) with ESMTP id 0BA9410B7 for ; Fri, 2 Feb 2018 10:28:27 +0100 (CET) Received: from gwchk03.silk.ntt-tx.co.jp (gwchk03.silk.ntt-tx.co.jp [10.107.0.111]) by mail04.ics.ntt-tx.co.jp (unknown) with ESMTP id w129SPsj007841; Fri, 2 Feb 2018 18:28:26 +0900 Received: (from root@localhost) by gwchk03.silk.ntt-tx.co.jp (unknown) id w129SPw2010073; Fri, 2 Feb 2018 18:28:25 +0900 Received: from gwchk.silk.ntt-tx.co.jp [10.107.0.110] by gwchk03.silk.ntt-tx.co.jp with ESMTP id UAA10072; Fri, 2 Feb 2018 18:28:25 +0900 Received: from imss06.silk.ntt-tx.co.jp (localhost [127.0.0.1]) by ccmail03.silk.ntt-tx.co.jp (unknown) with ESMTP id w129SPKC029897; Fri, 2 Feb 2018 18:28:25 +0900 Received: from imss06.silk.ntt-tx.co.jp (localhost [127.0.0.1]) by imss06.silk.ntt-tx.co.jp (unknown) with ESMTP id w129SOUK022298; Fri, 2 Feb 2018 18:28:24 +0900 Received: from ccmail03 (smtp03.silk.ntt-tx.co.jp [10.107.0.135]) by imss06.silk.ntt-tx.co.jp (unknown) with SMTP id w129SO7S022295; Fri, 2 Feb 2018 18:28:24 +0900 Date: Fri, 02 Feb 2018 18:27:56 +0900 From: Nakamura Hioryuki In-Reply-To: <3145253.k4F035SiiW@xps> References: <8006b50e-efa1-baf7-6474-e26c9403a84c@intel.com> <3145253.k4F035SiiW@xps> MIME-Version: 1.0 Content-Type: text/plain; charset="US-ASCII" Content-Transfer-Encoding: 7bit X-Mailer: Becky! ver. 2.73 [ja] X-CCMail7: CC-Mail-V7.0.2-Client-Relayed Message-Id: <201802020928.w129RqYX029490@ccmail03.silk.ntt-tx.co.jp> X-TM-AS-MML: No X-CC-Mail-RelayStamp: CC-Mail-V5.14-Server To: Thomas Monjalon , Yasufumi Ogawa , Ferruh Yigit Cc: spp@dpdk.org, srv-apl-arch@lab.ntt.co.jp Subject: Re: [spp] [spp 02114] Re: 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: Fri, 02 Feb 2018 09:28:28 -0000 > 01/02/2018 13:50, Ferruh Yigit: > > On 2/1/2018 4:00 AM, Yasufumi Ogawa wrote: > > > 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 > > > > I think this is good idea, I check the docs and looks pretty good. > > > > > > > > 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. > > > > And I think this is good idea, cc'ed Thomas for comment. > > Yes we can host it on dpdk.org and automate the generation at each tag. Thanks, Thomas, Ferruh and Yasufumi Of course, we all agree. -- Nakamura Hioryuki