diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/index.rst | 16 | ||||
| -rw-r--r-- | doc/index.rst.in | 23 |
2 files changed, 32 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 ================== 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` |