History

Ziye Yang 86f80d2d70 doc, nvmf: change discovery to discover Change-Id: If545f24d4737c190bc90e4a82155cbddbfef5bb0 Signed-off-by: Ziye Yang <ziye.yang@intel.com>		2017-02-09 09:56:36 -07:00
..
event	event: move component descriptions to doc/ and rewrite	2017-01-31 14:50:29 -07:00
ioat	doc: Convert ioat doc to markdown	2017-01-05 08:33:59 -07:00
iscsi	bdev/nvme: remove NvmeLunsPerNs and LunSizeInMB	2017-01-30 13:51:18 -07:00
nvme	doc/nvme: add admin functions to Key Functions	2017-01-13 12:37:41 -07:00
nvmf	doc, nvmf: change discovery to discover	2017-02-09 09:56:36 -07:00
directory_structure.md	doc: Convert directory structure to markdown	2017-01-05 08:33:59 -07:00
Doxyfile	event: move component descriptions to doc/ and rewrite	2017-01-31 14:50:29 -07:00
footer.html	doc: remove Doxygen footer	2017-01-17 16:54:31 -07:00
header.html	doc: point Documentation link at index page	2017-01-18 16:07:31 -07:00
index.md	event: move component descriptions to doc/ and rewrite	2017-01-31 14:50:29 -07:00
Makefile	doc: merge ioat and nvme into a single Doxyfile	2016-03-25 09:59:39 -07:00
porting.md	doc: move porting guide into doc/ and add to index	2017-01-17 16:25:04 -07:00
README.md	Change doc link to new spdk.io/doc location	2016-12-19 15:57:12 -07:00
stylesheet.css	doc: cut out whitespace between header and content	2017-01-30 14:08:06 -07:00

README.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.