History

Ben Walker 55ca1581d6 doc: Convert directory structure to markdown Change-Id: I3af62591658ccd2ae664d73ab5a680a9725469e7 Signed-off-by: Ben Walker <benjamin.walker@intel.com>		2017-01-05 08:33:59 -07:00
..
ioat	doc: organize Key Functions into tables	2016-08-15 16:07:26 -07:00
iscsi	bdev: remove unused field in data struct nvme_bdf_whitelist	2016-10-14 01:55:16 +08:00
nvme	doc: update link to renamed deallocate function	2016-12-08 10:01:08 -07:00
nvmf	doc: replace another "NVMf" with NVMe over Fabrics	2016-08-15 16:07:26 -07:00
directory_structure.md	doc: Convert directory structure to markdown	2017-01-05 08:33:59 -07:00
Doxyfile	doc: Convert directory structure to markdown	2017-01-05 08:33:59 -07:00
footer.html	Change doc link to new spdk.io/doc location	2016-12-19 15:57:12 -07:00
header.html	docs: Update header and footer links in documentation	2016-07-01 14:51:35 -07:00
index.md	doc: Convert directory structure to markdown	2017-01-05 08:33:59 -07:00
Makefile	doc: merge ioat and nvme into a single Doxyfile	2016-03-25 09:59:39 -07:00
README.md	Change doc link to new spdk.io/doc location	2016-12-19 15:57:12 -07:00
stylesheet.css	eofnl: check for extra trailing newlines	2016-10-11 13:30:33 -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.