summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:25:24 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:25:24 +0000
commitacf73199fa227b97217238334236af367c8ab2d7 (patch)
treeb6812bd6cbe6b977884ec94def20de59555983d5 /doc/index.rst
parentAdding upstream version 1.0. (diff)
downloadlibnvme-acf73199fa227b97217238334236af367c8ab2d7.tar.xz
libnvme-acf73199fa227b97217238334236af367c8ab2d7.zip
Adding upstream version 1.1~rc0.upstream/1.1_rc0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 639b3d5..54c2415 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,17 +1,19 @@
-.. libnvme documentation master file, created by
- sphinx-quickstart on Thu Feb 6 17:59:42 2020.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
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:
- libnvme
-
+ installation.rst
+ quickstart.rst
+ mi.rst
+ api.rst
Indices and tables
==================