2016-09-28 21:25:14 +00:00
|
|
|
SPDK Documentation
|
|
|
|
==================
|
|
|
|
|
|
|
|
The current version of the SPDK documentation can be found online at
|
2016-12-19 21:09:02 +00:00
|
|
|
http://www.spdk.io/doc/
|
2016-09-28 21:25:14 +00:00
|
|
|
|
|
|
|
Building the Documentation
|
|
|
|
==========================
|
|
|
|
|
2018-02-14 00:10:25 +00:00
|
|
|
To convert the documentation into HTML run `make` in the `doc`
|
|
|
|
directory. The output will be located in `doc/output/html`. Before
|
|
|
|
running `make` ensure all pre-requisites are installed. See
|
|
|
|
[Installing Prerequisites](http://www.spdk.io/doc/getting_started.html)
|
|
|
|
for more details.
|