summaryrefslogtreecommitdiffstats
path: root/src/spdk/doc/README.md
blob: c5c03b287036e25ca5cdd9a025319e52a32ad9a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 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.