d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
98149ec0a7
numam-spdk/doc
History
Ben Walker 98149ec0a7 doc: Convert mainpage to Markdown 
Convert to markdown. Our other GitHub files are in markdown
and doxygen natively supports it, so begin converting the
documentation entirely to markdown to minimize the number
of formats we have to comprehend.

Also rename it to index.md to match the other top level
files. Index and mainpage are interchangeable terms in
Doxygen.

Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986
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.txt doc: Begin documenting the directory structure 2016-12-07 16:03:16 -07:00
Doxyfile doc: Convert mainpage 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 mainpage 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.