d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
7c3214a0ac
numam-spdk/doc
History
Daniel Verkamp b23409854c doc: point Documentation link at index page 
Rather than hard-coding the spdk.io/doc link, change the Doxygen header
to output a link to index.html (the main Doxygen page) so that it will
always point within the current doc tree.

This is important for archived release versions of the documentation,
since their documentation link should point at their own main page, not
the current master doc.

Change-Id: I788eee995543e425c24ff787f3f13956c5b813b7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-18 16:07:31 -07:00
..
ioat doc: Convert ioat doc to markdown 2017-01-05 08:33:59 -07:00
iscsi doc: Convert iscsi doc to markdown 2017-01-05 16:21:28 -07:00
nvme doc/nvme: add admin functions to Key Functions 2017-01-13 12:37:41 -07:00
nvmf doc: Convert nvmf doc to markdown 2017-01-05 16:21:27 -07:00
directory_structure.md doc: Convert directory structure to markdown 2017-01-05 08:33:59 -07:00
Doxyfile doc: delete Doxygen header bar 2017-01-18 10:06:40 -07:00
footer.html doc: remove Doxygen footer 2017-01-17 16:54:31 -07:00
header.html doc: point Documentation link at index page 2017-01-18 16:07:31 -07:00
index.md doc: link to Doxygen's file list from main page 2017-01-17 17:39:01 -07:00
Makefile doc: merge ioat and nvme into a single Doxyfile 2016-03-25 09:59:39 -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 docs: Match doxygen output to spdk.io 2017-01-09 15:52:51 -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.