summaryrefslogtreecommitdiffstats
path: root/doc/index.rst.in
blob: 54c2415b4632a9ca676b272e9a5b06a3b159c3dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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`