From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 04A30A84E for ; Thu, 1 Feb 2018 14:11:32 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 612E520E5B; Thu, 1 Feb 2018 08:11:31 -0500 (EST) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Thu, 01 Feb 2018 08:11:31 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc; s=mesmtp; bh=jf4v0uwb82fQBXxNpf/vMSG/z/ /WH0oimSn7cgrcH84=; b=eCnREtAsSgd+aeMQ0ilzhlUnkkk54Heiqugh2S9MJJ RyLUHR55Gn12YYCf+nU55JNJ9vUM5z+vHrmrs65malYuXWa9SHUHtRH4kEaj1q34 eLw0P/tZUxud1JLJ86elzWv3Ll3bYzmYaRRIm8V9h4MciWy0bldqhk0OulKMttrV E= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=jf4v0u wb82fQBXxNpf/vMSG/z//WH0oimSn7cgrcH84=; b=HfjTmooaZ0qKLtLIQv8p+8 ImMvWGKeJ4z40o0WlUfBRhC1cGdY6DBHF2mwGJ6Y3r7bhlgEJP9xBA9sO2oLRZad CsmcL7y+rZpat6ken7cv/ajvHfEHoDSg0spGFn/v19tzYWrMLJe5Tug/1PKig/cw 6IJMhFCvac3cyo5+JNKmKAq4d6Q/bZCzD7f+aL20BxAd8Ixx8vMilnbmzNFFi1vm GYS0+3HDNI2C9YIAbXRGJ0tkegWgpnH6wi0L0vEwYHtrBMAyg1qtm5JOWGD+TGnL enzlAq919KVXBgza0I8nzFc4woIRon4Y8MEiV7kRQ9H/L4KWcEBPNDmojrBIOqcQ == X-ME-Sender: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 0B2DD246D5; Thu, 1 Feb 2018 08:11:31 -0500 (EST) From: Thomas Monjalon To: Yasufumi Ogawa Cc: Ferruh Yigit , spp@dpdk.org, srv-apl-arch@lab.ntt.co.jp Date: Thu, 01 Feb 2018 14:10:44 +0100 Message-ID: <3145253.k4F035SiiW@xps> In-Reply-To: <8006b50e-efa1-baf7-6474-e26c9403a84c@intel.com> References: <5fa35014-45df-6ad6-cb66-d01b6e698d3b@lab.ntt.co.jp> <8006b50e-efa1-baf7-6474-e26c9403a84c@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [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 13:11:32 -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.