summaryrefslogtreecommitdiffstats
path: root/doc/index.rst.in
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.in
parentAdding upstream version 1.0. (diff)
downloadlibnvme-a8ab4da9e004c83c3b8a68f348b1cd00b984fe86.tar.xz
libnvme-a8ab4da9e004c83c3b8a68f348b1cd00b984fe86.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.in')
-rw-r--r--doc/index.rst.in23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/index.rst.in b/doc/index.rst.in
new file mode 100644
index 0000000..54c2415
--- /dev/null
+++ b/doc/index.rst.in
@@ -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`