From 7fecc4881a3cbbdbd085b9c59d04668139b75557 Mon Sep 17 00:00:00 2001 From: Boris Glimcher Date: Wed, 13 Apr 2022 11:29:22 +0300 Subject: [PATCH] doc: add quickstart and installation Signed-off-by: Boris Glimcher --- doc/api.rst | 17 +++++++++++++++++ doc/api.rst.in | 17 +++++++++++++++++ doc/index.rst | 17 ++++++++--------- doc/installation.rst | 24 ++++++++++++++++++++++++ doc/installation.rst.in | 24 ++++++++++++++++++++++++ doc/meson.build | 3 +++ doc/quickstart.rst | 5 +++++ doc/quickstart.rst.in | 5 +++++ 8 files changed, 103 insertions(+), 9 deletions(-) create mode 100644 doc/api.rst create mode 100644 doc/api.rst.in create mode 100644 doc/installation.rst create mode 100644 doc/installation.rst.in create mode 100644 doc/quickstart.rst create mode 100644 doc/quickstart.rst.in diff --git a/doc/api.rst b/doc/api.rst new file mode 100644 index 00000000..3c0a9c48 --- /dev/null +++ b/doc/api.rst @@ -0,0 +1,17 @@ +=== +API +=== + +.. module:: libnvme + +This part of the documentation lists the full API reference of all public classes and +functions. + +.. include:: rst/types.rst +.. include:: rst/ioctl.rst +.. include:: rst/fabrics.rst +.. include:: rst/linux.rst +.. include:: rst/tree.rst +.. include:: rst/filters.rst +.. include:: rst/util.rst +.. include:: rst/log.rst diff --git a/doc/api.rst.in b/doc/api.rst.in new file mode 100644 index 00000000..3c0a9c48 --- /dev/null +++ b/doc/api.rst.in @@ -0,0 +1,17 @@ +=== +API +=== + +.. module:: libnvme + +This part of the documentation lists the full API reference of all public classes and +functions. + +.. include:: rst/types.rst +.. include:: rst/ioctl.rst +.. include:: rst/fabrics.rst +.. include:: rst/linux.rst +.. include:: rst/tree.rst +.. include:: rst/filters.rst +.. include:: rst/util.rst +.. include:: rst/log.rst diff --git a/doc/index.rst b/doc/index.rst index b77cf835..c1b141f2 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,19 +1,18 @@ 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: -.. include:: rst/types.rst -.. include:: rst/ioctl.rst -.. include:: rst/fabrics.rst -.. include:: rst/linux.rst -.. include:: rst/tree.rst -.. include:: rst/filters.rst -.. include:: rst/util.rst -.. include:: rst/log.rst - + installation.rst + quickstart.rst + api.rst Indices and tables ================== diff --git a/doc/installation.rst b/doc/installation.rst new file mode 100644 index 00000000..c4544a50 --- /dev/null +++ b/doc/installation.rst @@ -0,0 +1,24 @@ +Installation +============ + +Python Version +-------------- + +tbd + +Dependencies +------------ + +tbd + +Install libnvme +------------- + +libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is +always the latest stable release. + +.. _PyPi: https://pypi.org/project/libnvme/ + +.. code-block:: sh + + $ pip install libnvme diff --git a/doc/installation.rst.in b/doc/installation.rst.in new file mode 100644 index 00000000..c4544a50 --- /dev/null +++ b/doc/installation.rst.in @@ -0,0 +1,24 @@ +Installation +============ + +Python Version +-------------- + +tbd + +Dependencies +------------ + +tbd + +Install libnvme +------------- + +libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is +always the latest stable release. + +.. _PyPi: https://pypi.org/project/libnvme/ + +.. code-block:: sh + + $ pip install libnvme diff --git a/doc/meson.build b/doc/meson.build index 00dbff3a..574eb89f 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -21,7 +21,10 @@ api_files = [ sphinx_sources = [ 'conf.py', + 'api.rst', 'index.rst', + 'quickstart.rst', + 'installation.rst', 'config-schema.json' ] diff --git a/doc/quickstart.rst b/doc/quickstart.rst new file mode 100644 index 00000000..d3561889 --- /dev/null +++ b/doc/quickstart.rst @@ -0,0 +1,5 @@ +========== +Quickstart +========== + +tbd \ No newline at end of file diff --git a/doc/quickstart.rst.in b/doc/quickstart.rst.in new file mode 100644 index 00000000..d3561889 --- /dev/null +++ b/doc/quickstart.rst.in @@ -0,0 +1,5 @@ +========== +Quickstart +========== + +tbd \ No newline at end of file -- 2.50.1