numam-spdk/doc
Daniel Verkamp c20aa93181 doc: add README.md for Doxygen and online docs
Change-Id: I9af8a77ac1faccf950669f8e61c6ea4d596209c7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-10-03 14:23:15 -07:00
..
ioat doc: organize Key Functions into tables 2016-08-15 16:07:26 -07:00
iscsi bdev: Add RBD support in lib/bdev 2016-09-30 15:26:28 -07:00
nvme doc: organize Key Functions into tables 2016-08-15 16:07:26 -07:00
nvmf doc: replace another "NVMf" with NVMe over Fabrics 2016-08-15 16:07:26 -07:00
Doxyfile iscsi: add document description about iSCSI target 2016-09-02 09:21:58 -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 iscsi: add document description about iSCSI target 2016-09-02 09:21:58 -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 doc: use spdk.io stylesheets 2016-03-25 14:00:15 -07:00

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.