From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 5C17D199B5 for ; Thu, 1 Feb 2018 13:50:43 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Feb 2018 04:50:42 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,444,1511856000"; d="scan'208";a="14574594" Received: from fyigit-mobl1.ger.corp.intel.com (HELO [10.237.220.157]) ([10.237.220.157]) by fmsmga007.fm.intel.com with ESMTP; 01 Feb 2018 04:50:40 -0800 To: Yasufumi Ogawa , spp@dpdk.org Cc: srv-apl-arch@lab.ntt.co.jp, Thomas Monjalon References: <5fa35014-45df-6ad6-cb66-d01b6e698d3b@lab.ntt.co.jp> From: Ferruh Yigit Message-ID: <8006b50e-efa1-baf7-6474-e26c9403a84c@intel.com> Date: Thu, 1 Feb 2018 12:50:40 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.5.2 MIME-Version: 1.0 In-Reply-To: <5fa35014-45df-6ad6-cb66-d01b6e698d3b@lab.ntt.co.jp> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit 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 12:50:43 -0000 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. > > Thanks, > Yasufumi >