[spp] Proposal for RST documentation support
Ferruh Yigit
ferruh.yigit at intel.com
Thu Feb 1 13:50:40 CET 2018
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
>
More information about the spp
mailing list