diff options
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..54c2415 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,23 @@ +Welcome to libnvme's documentation! +=================================== + +This is the libnvme development C library. libnvme provides type definitions for +NVMe specification structures, enumerations, and bit fields, +helper functions to construct, dispatch, and decode commands and payloads, +and utilities to connect, scan, and manage nvme devices on a Linux system. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation.rst + quickstart.rst + mi.rst + api.rst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |