878bec9d73
The htmlonly element that uses javascript to draw a diagram hinders readability of the document in typical terminal-based editors, on github/gitlab, etc. Not even the official documentation at https://spdk.io/doc/blob.html renders it, at least in part because Two.js is not present. ASCII art can easily convey the same information in a much more accessible way. Signed-off-by: Mike Gerdts <mgerdts@nvidia.com> Change-Id: I5779d4639b1bee8a976d915d6853f11b05a35b71 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/11269 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
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
for more details.