History

Daniel Verkamp 6db4f2b072 doc: update link to renamed deallocate function Change-Id: Ifc93a761635a2c0922813d0f8bb3efbc1ab6136b Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2016-12-08 10:01:08 -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.txt	doc: Begin documenting the directory structure	2016-12-07 16:03:16 -07:00
Doxyfile	doc: Begin documenting the directory structure	2016-12-07 16:03:16 -07:00
footer.html	docs: Update header and footer links in documentation	2016-07-01 14:51:35 -07:00
header.html	docs: Update header and footer links in documentation	2016-07-01 14:51:35 -07:00
mainpage.txt	doc: Begin documenting the directory structure	2016-12-07 16:03:16 -07:00
Makefile	doc: merge ioat and nvme into a single Doxyfile	2016-03-25 09:59:39 -07:00
README.md	doc: add README.md for Doxygen and online docs	2016-10-03 14:23:15 -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/spdk/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.