ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1a787169b2
Spdk/doc
History
Daniel Verkamp 1a787169b2 doc: flatten Markdown docs into chapter-per-file 
Doxygen interprets each Markdown input file as a separate section
(chapter).  Concatenate all of the .md files in directories into a
single file per section to get a correctly-nested table of contents.

In particular, this matters for the navigation in the PDF output.

Change-Id: I778849d89da9a308136e43ac6cb630c4c2bbb3a5
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-04-30 07:58:26 -07:00
..
bdev.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
blob.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
blobfs.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
event.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
Makefile doc: merge ioat and nvme into a single Doxyfile 2016-03-25 09:59:39 -07:00
nvme.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
nvmf.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -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: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
vhost.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -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.