History

Daniel Verkamp 8bbd56fb64 doc: enable Doxygen tree view navigation

This requires an override of Bootstrap's default box-sizing: border-box
on the nav bar elements so Doyxgen's tree view layout isn't broken.

Change-Id: I38d1df10fef8d90e245bbd880cf85686c1aee470
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/384382
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>

2017-10-31 18:00:12 -04:00

.gitignore

doc: include changelog in documentation

2017-08-28 13:44:13 -04:00

bdev.md

bdev_virtio: added doc page

2017-10-20 19:44:23 -04:00

blob.md

blobstore: add bstype to blobstore super block

2017-10-17 13:36:03 -04:00

blobfs.md

scripts: replace NRHUGE with HUGEMEM in setup.sh

2017-10-12 18:27:21 -04:00

directory_structure.md

vhost: Getting Started for SPDK vhost

2017-03-29 13:09:57 -07:00

Doxyfile

doc: enable Doxygen tree view navigation

2017-10-31 18:00:12 -04: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

getting_started.md

scripts: replace NRHUGE with HUGEMEM in setup.sh

2017-10-12 18:27:21 -04:00

header.html

doc: simplify HTML header and stylesheet

2017-04-28 13:13:48 -07:00

index.md

bdev_virtio: added doc page

2017-10-20 19:44:23 -04:00

ioat.md

doc: flatten Markdown docs into chapter-per-file

2017-04-30 07:58:26 -07:00

iscsi.md

doc: add a section for user guides

2017-09-26 19:40:58 -04:00

jsonrpc.md

doc: add JSON-RPC docs for nvmf_tgt methods

2017-10-12 16:37:52 -04:00

lvol.md

lvol: updated documentation.

2017-10-26 15:04:27 -04:00

Makefile

doc: include changelog in documentation

2017-08-28 13:44:13 -04:00

memory.md

Add documentation explaining memory management

2017-06-15 14:11:58 -04:00

nvme-cli.md

doc: add the documentation for nvme-cli support

2017-07-19 13:52:14 -04:00

nvme.md

doc: Improve NVMe documentation entry page

2017-06-22 15:49:28 -04:00

nvmf.md

doc: add a section for user guides

2017-09-26 19:40:58 -04: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: enable Doxygen tree view navigation

2017-10-31 18:00:12 -04:00

vagrant.md

doc/vagrant: add commands to run for proxyconf

2017-09-18 12:53:49 -04:00

vhost.md

doc: update vhost known bugs section

2017-08-10 13:35:18 -04:00

virtio.md

bdev_virtio: added doc page

2017-10-20 19:44:23 -04: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.